ワークフロー用 Webhook の作成と管理

必要な Webhook 権限

Qlik Cloud Webhooks API と自動化 UI を使用して Webhook を作成または管理する場合は、次の権限のいずれかまたは両方をリクエストする必要があります。

• Webhook を使用: ユーザーが所有する Webhook を作成、表示、更新、削除するために必要です。

• Webhook を管理: 他のユーザーが作成したものも含め、テナント内のすべての Webhook を管理するために必要です。

Webhooks の仕組み

Qlik Cloud でイベントが発生 (新しいアプリの作成、またはユーザーの削除など) すると、Webhook は HTTP コールバックを使用して、指定された外部アプリケーションに JSON 形式で情報を送信します。この外部アプリケーションは、イベント データを使用してさらなるアクションをトリガーできます。

例:

• 新しいアプリが作成されたら、Slack を通じてチームに通知します。

• 新しいチーム メンバーがテナントに追加されたときに、自動的にウェルカム メールを送信します。

• ユーザーがテナントから削除されたときにスプレッドシートを更新します。

Webhooks を使用するメリット

Webhook を使用すると、他のシステムとのリアルタイムの統合が可能になり、継続的な手動チェックや API リクエストの繰り返しが不要になります。Webhook はイベントをリッスンし、関連データを即時に送信することで、不要な作業が減少し、スムーズな自動化を実現します。

Webhook 統合に人気のプラットフォーム

Webhook データの処理と応答には、カスタム サービスを構築するか、次のようなサードパーティ プラットフォームを使用します。

• Qlik Automate (英語のみ)

• Pipedream

• Zapier

• Microsoft Power Automate

Webhook の制限

システム パフォーマンスを維持し、リソースを管理するために、次の制限が適用されます。

• Webhook の配信履歴は 7 日間保持されます。

• 各ユーザーは最大 150 個の Webhook を所有できます。

• テナントごとに最大 100 個の Webhook を作成できます。

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
        }
    }
}

Webhook の作成

Webhook は次のユーザーが作成できます。

• 管理 アクティビティ センターからのテナント管理者。

• Qlik Automate インターフェイスからのすべてのユーザー。

Qlik Automate での Webhook の使用の詳細については、「Webhook の操作 (英語のみ)」を参照してください。

次の手順を実行します。

1. 管理 アクティビティ センターで、 [Webhooks] に移動します。

2. [新規作成] をクリックします。

3. Webhook の名前を入力し、必要に応じて説明を追加します。

4. URL (エンドポイント) には、Webhook が JSON データを送信する完全修飾ドメイン名 (FQDN) を入力します。

   • この URL では HTTPS プロトコルを使用する必要があります (例: https://domain.com)。IP アドレスを Webhook のエンドポイントとして使用することはできません。

5. 必要に応じて、Webhook 認証用シークレットを入力します。

   • シークレットは 32 文字から 64 文字の間である必要があります。

   • 作成された場合、シークレットはハッシュの一部として含まれ、qlik-signature として HTTP リクエストに追加されます。

6. 必要に応じて、リクエストに追加する HTTP ヘッダーを追加します。ヘッダー値を暗号化するには、チェックボックスを選択します

   情報メモセキュリティ上の理由から、暗号化されたヘッダーは編集できません。ヘッダーを削除するには、削除アイコンをクリックします。値を削除するには、削除アイコンをクリックして新しい値を入力します。

7. [イベント] で、Webhook をトリガーするシステム イベントを選択します。使用できるイベントは次のとおりです。

   • アプリ イベント: 作成済み、削除済み、エクスポート済み、データ更新済み (リフレッシュ済み)、公開済み、リロード済み。

   • ユーザー イベント: 作成済み、削除済み。

8. [作成] をクリックします。

Webhook の管理

Webhook の並べ替えと検索

テーブル内の Webhook は次の方法で並べ替えおよび検索します。

• 並べ替えの順序を変更するには、列の上部にある をクリックします。

• 列の上部にある をクリックして、Webhook を検索します。検索フィルターは、完全一致と部分一致を使用できます。

Webhook をオンにするまたはオフにする

次の手順を実行します。

1. 管理 アクティビティ センターで、 [Webhooks] に移動します。

2. Webhook の横の をクリックします。

3. Webhook をオンにするには、 [Webhook の有効化] を選択します。

4. Webhook をオフにするには、 [Webhook の無効化] を選択します。

新しく作成された Webhook は既定で有効になっています

Webhook の編集

次の手順を実行します。

1. 管理 アクティビティ センターで、 [Webhooks] に移動します。

2. 編集する Webhook で、 をクリックします。

3. [編集] を選択します。

4. 編集して [保存] をクリックします。

Webhook の削除

次の手順を実行します。

1. 管理 アクティビティ センターで、 [Webhooks] に移動します。

2. 削除する Webhook を選択します。

3. [削除] をクリックします。

4. 削除を確定します。

Webhook 履歴の表示

Webhook のイベント履歴は 7 日間保持されます。

次の手順を実行します。

1. 管理 アクティビティ センターで、 [Webhooks] に移動します。

2. Webhook の横の をクリックすると、イベント履歴が展開されます。

   

3. イベント配信を手動で再配信するには、イベント行の をクリックします。

4. イベント応答ペイロードを表示するには、イベント行の をクリックします。

   ペイロードには、アプリ ID、名前、日付と時刻などの詳細が表示され、過去のイベントのデバッグや監査に役立ちます。