기본 콘텐츠로 건너뛰기 보완적인 콘텐츠로 건너뛰기

워크플로에 대한 웹후크 만들기 및 관리

웹후크는 특정 작업이 발생할 때 이벤트 데이터를 자동으로 전송하여 응용 프로그램 간 통신을 자동화하는 간단한 방법입니다. Qlik Cloud에서 웹후크는 수동 개입 없이 다른 응용 프로그램에서 작업을 트리거할 수 있으므로 Qlik Cloud를 워크플로에 통합하고 시스템 이벤트에 따라 작업을 자동화하는 것이 더 쉬워집니다. 정의된 이벤트가 발생할 때마다 지정된 웹후크 종료 지점으로 JSON 요청이 전송되어 선택한 응용 프로그램에 이벤트 데이터가 전달됩니다.

필수 웹후크 권한

Qlik Cloud 웹후크 API 및 자동화 UI를 사용하여 웹후크를 만들거나 관리할 때 다음 권한 중 하나 또는 둘 다를 요청해야 합니다.

  • 웹후크 사용: 사용자가 소유한 웹후크를 만들고, 보고, 업데이트하고, 삭제하는 데 필요합니다.

  • 웹후크 관리: 다른 사용자가 만든 웹후크를 포함하여 테넌트의 모든 웹후크를 관리하는 데 필요합니다.

웹후크 이해

웹후크 작동 방식

Qlik Cloud에서 이벤트가 발생하면(예: 새 앱 만들기 또는 사용자 삭제), 웹후크는 HTTP 콜백을 사용하여 지정된 외부 응용 프로그램에 JSON 형식의 정보를 전송합니다. 그러면 외부 응용 프로그램은 이벤트 데이터를 사용하여 추가 작업을 트리거할 수 있습니다.

예:

  • 새로운 이 만들어지면 Slack을 통해 팀에 알립니다.

  • 테넌트에 새로운 팀원이 추가되면 자동으로 환영 이메일을 보냅니다.

  • 테넌트에서 사용자가 삭제되면 스프레드시트를 업데이트합니다.

웹후크 사용의 이점

웹후크를 사용하면 다른 시스템과 실시간으로 통합할 수 있으므로 지속적인 수동 확인이나 반복적인 API 요청이 필요 없습니다. 이벤트를 수신하고 관련 데이터를 즉시 전송함으로써 웹후크는 불필요한 작업을 줄이고 원활한 자동화를 가능하게 합니다.

웹후크 통합을 위한 인기 플랫폼

웹후크 데이터를 처리하고 이에 응답하려면 사용자 지정 서비스를 빌드하거나 다음과 같은 타사 플랫폼을 사용할 수 있습니다.

웹후크 제한

시스템 성능을 유지하고 리소스를 관리하기 위해 다음과 같은 제한이 적용됩니다.

  • 웹후크 전달 내역은 7일간 보관됩니다.

  • 각 사용자는 최대 150개의 웹후크를 소유할 수 있습니다.

  • 테넌트당 최대 100개의 웹후크를 만들 수 있습니다.

웹후크 요청 구조

이벤트에 의해 웹후크가 트리거되면, 웹후크 생성 중에 지정된 종료 지점에 HTTP JSON 요청을 전송합니다. 이 요청의 구조에는 이벤트 유형, 타임스탬프 및 객체 속성과 같은 이벤트 메타데이터 및 페이로드 세부 정보가 포함됩니다.

웹후크 요청 예: 앱 삭제 이벤트

앱이 삭제될 때 전송되는 JSON 요청의 예는 다음과 같습니다.

요청 URL

https://<your-tenantURL>/api/v1/webhooks/{id}

헤더


{
    "Content-Type": "application/json",
    "X-Execution-Token: <your-execution-token>",
    "Qlik-Signature": "446bd5e3f5b635f491d17557e4bec6ebc61b7bd2bc9cc7b612e4e",
    "User-Agent": "Qlik Webhook"
}

본문


{
    "cloudEventsVersion": "0.1",
    "source": "com.qlik/engine",
    "contentType": "application/json",
    "eventId": "e65c1481-e8a-4be-a5ca-27dfcde077d7",
    "eventTime": "2021-03-08T14:51:29Z",
    "eventTypeVersion": "1.0.0",
    "eventType": "com.qlik.v1.app.deleted",
    "extensions": {
        "ownerId": "vNRGrDZIypJzauw59BbpvkRhqbmI",
        "tenantId": "oZcMPa_1PwH4FUdrh6839YHHdEJN",
        "userId": "vNRGrDZIypJtcGTzauw59BbpqbmI"
    },
    "data": {
        "attributes": {
            "id": "0984fec4-aa8c-4253-b1d1-4fd4f9c78",
            "name": "New App",
            "createdDate": "2021-03-08T14:51:28.888Z",
            "modifiedDate": "2021-03-08T14:51:29.316Z",
            "owner": "auth0|b62a17c577a4abe6e807b07d18c4d82286352542d633d120100b03fb11",
            "ownerId": "vNRGrDZIypJtcGTzauw59BbpvbmI",
            "published": false,
            "hasSectionAccess": false
        }
    }
}

이 페이로드는 ID, 이름, 소유자, 삭제 타임스탬프 등 삭제된 앱에 대한 자세한 정보를 제공하여 수신 시스템이 이벤트를 처리하는 데 도움이 됩니다. 이벤트 페이로드에 대한 자세한 내용은 Qlik 개발자 포털: API 이벤트를 참조하십시오.

암호화된 헤더

Qlik Cloud는 암호화된 HTTP 헤더를 지원합니다. 암호화된 헤더를 사용하면 중요한 메타데이터를 더욱 안전하게 보호할 수 있습니다. 작동 방식:

  • 암호화된 헤더 값: 웹후크를 구성할 때 웹후크에 구성된 헤더 값을 암호화할 수 있습니다. 이를 통해 전달 토큰이나 API 키와 같은 자격 증명이 안전하게 저장되고 처리됩니다. 웹후크 비밀은 한 번만 쓸 수 있습니다. 한 번 저장하면 비밀을 보거나 검색할 수 없으므로 실수로 노출될 위험이 줄어듭니다.

정보 메모헤더는 전송 중이 아닌 저장 중에 암호화됩니다.

웹후크 만들기

웹후크는 다음을 통해 만들 수 있습니다.

  • 관리 활동 센터의 테넌트 관리자입니다.

  • Qlik Automate 인터페이스의 모든 사용자.

Qlik Automate과 함께 웹후크를 사용하는 방법에 대한 자세한 내용은 웹후크 작업 (영어로만 제공)을 참조하십시오.

다음과 같이 하십시오.

  1. 관리 활동 센터에서 웹후크로 이동합니다.

  2. 새로 만들기를 클릭합니다.

  3. 웹후크의 이름을 입력하고, 원하는 경우 설명을 추가합니다.

  4. URL(종료 지점)에 웹후크가 JSON 데이터를 보낼 정규화된 도메인 이름(FQDN)을 입력합니다.

    • 이 URL은 HTTPS 프로토콜을 사용해야 합니다(예: https://domain.com). IP 주소는 웹후크 종료 지점으로 사용할 수 없습니다.

  5. 선택적으로 웹후크 인증을 위한 비밀을 입력합니다.

    • 비밀은 32자에서 64자 사이여야 합니다.

    • 만들어진 경우 비밀은 해시의 일부로 포함되어 HTTP 요청에 qlik-signature로 추가됩니다.

  6. 선택적으로 요청에 추가할 HTTP 헤더를 추가합니다. 헤더 값을 암호화하려면 확인란을 선택합니다.

    정보 메모보안상의 이유로 암호화된 헤더를 편집할 수 없습니다. 헤더를 삭제하려면 삭제 아이콘을 클릭합니다. 값을 제거하려면 제거 아이콘을 클릭하고 새 값을 입력합니다.
  7. 이벤트에서 웹후크를 트리거할 시스템 이벤트를 선택합니다. 이용 가능한 이벤트는 다음과 같습니다.

    • 앱 이벤트: 만들어짐, 삭제됨 내보냄, 데이터 업데이트됨(새로고침됨), 게시됨, 다시 로드됨.

    • 사용자 이벤트: 만들어짐, 삭제됨.

  8. 만들기를 클릭합니다.

웹후크 관리

웹후크 정렬 및 검색

표에서 웹후크를 정렬하고 검색하려면:

  • 정렬 순서를 변경하려면 열 상단의 위아래 화살표을 클릭합니다.

  • 웹후크를 검색하려면 열 상단의 필터을 클릭합니다. 검색 필터는 전체 일치 및 부분 일치에 적용됩니다.

웹후크 표.

관리 콘솔 웹후크 테이블

웹후크 켜기 또는 끄기

다음과 같이 하십시오.

  1. 관리 활동 센터에서 웹후크로 이동합니다.

  2. 웹후크 옆에 있는 자세히을 클릭합니다.

  3. 웹후크를 켜려면 웹후크 사용을 선택합니다.

  4. 웹후크를 끄려면 웹후크 비활성화를 선택합니다.

새로 만들어진 웹후크는 기본적으로 활성화됩니다.

웹후크 편집

다음과 같이 하십시오.

  1. 관리 활동 센터에서 웹후크로 이동합니다.

  2. 편집하려는 웹후크에 대해 자세히을 클릭합니다.

  3. 편집을 선택합니다.

  4. 편집하고 저장을 클릭합니다.

웹후크 삭제

다음과 같이 하십시오.

  1. 관리 활동 센터에서 웹후크로 이동합니다.

  2. 삭제할 웹후크를 선택합니다.

  3. 삭제를 클릭합니다.

  4. 삭제를 확인합니다.

웹후크 기록 보기

웹후크 이벤트 기록은 7일 동안 보관됩니다.

다음과 같이 하십시오.

  1. 관리 활동 센터에서 웹후크로 이동합니다.

  2. 웹후크 옆에 있는 웹후크 메뉴를 확장하는 아래쪽 화살표 UI 아이콘을 클릭하여 이벤트 기록을 확장합니다.

    웹후크 기록.

    관리 콘솔 웹후크 기록
  3. 이벤트 전달을 수동으로 재전송하려면 이벤트 행에서 다시 보내기 아이콘을 클릭합니다.

  4. 이벤트 응답 페이로드를 보려면 이벤트 행에서 아래 화살표을 클릭합니다.

    페이로드에는 앱 ID, 이름, 타임스탬프와 같은 세부 정보가 표시되는데, 이는 과거 이벤트를 디버깅하거나 감사하는 데 유용합니다.

    이벤트 응답 페이로드.

    관리 콘솔 웹후크 이벤트 유형 페이로드 정보

이 페이지가 도움이 되었습니까?

이 페이지 또는 해당 콘텐츠에서 오타, 누락된 단계 또는 기술적 오류와 같은 문제를 발견하면 알려 주십시오!