# ワークフロー用 Webhook の作成と管理 Webhook は、特定のアクションが発生したときにイベント データを自動的に送信することで、アプリケーション間の通信を自動化する簡単な方法です。Qlik Cloud では、Webhook によって手動介入なしに他のアプリケーションでアクションをトリガーできるため、Qlik Cloud をワークフローに統合し、システム イベントに基づいてタスクを自動化することが容易になります。定義されたイベントが発生するたびに、指定された Webhook エンドポイントに JSON リクエストが送信され、選択したアプリケーションにイベント データが配信されます。 ## 必要な Webhook 権限 Qlik Cloud [Webhooks API](https://qlik.dev/apis/rest/webhooks/) と自動化 UI を使用して Webhook を作成または管理する場合は、次の権限のいずれかまたは両方をリクエストする必要があります。 * Webhook を使用: ユーザーが所有する Webhook を作成、表示、更新、削除するために必要です。 * Webhook を管理: 他のユーザーが作成したものも含め、テナント内のすべての Webhook を管理するために必要です。 ## Webhooks を理解する ### Webhooks の仕組み Qlik Cloud でイベントが発生 (新しいアプリケーションの作成、またはユーザーの削除など) すると、Webhook は HTTP コールバックを使用して、指定された外部アプリケーションに JSON 形式で情報を送信します。この外部アプリケーションは、イベント データを使用してさらなるアクションをトリガーできます。 例: * 新しいアプリケーションが作成されたら、Slack を通じてチームに通知します。 * 新しいチーム メンバーがテナントに追加されたときに、自動的にウェルカム メールを送信します。 * ユーザーがテナントから削除されたときにスプレッドシートを更新します。 ### Webhooks を使用するメリット Webhook を使用すると、他のシステムとのリアルタイムの統合が可能になり、継続的な手動チェックや API リクエストの繰り返しが不要になります。Webhook はイベントをリッスンし、関連データを即時に送信することで、不要な作業が減少し、スムーズな自動化を実現します。 ### Webhook 統合に人気のプラットフォーム Webhook データの処理と応答には、カスタム サービスを構築するか、次のようなサードパーティ プラットフォームを使用します。 * [Qlik Automate](https://help.qlik.com/en-US/cloud-services/Subsystems/ApplicationAutomation/Content/introduction/home-automation.htm) (英語のみ) * [Pipedream](https://pipedream.com/) * [Zapier](https://zapier.com/) * [Microsoft Power Automate](https://flow.microsoft.com/en-us/) ### Webhook の制限 システム パフォーマンスを維持し、リソースを管理するために、次の制限が適用されます。 * Webhook の配信履歴は 7 日間保持されます。 * 各ユーザーは最大 150 個の Webhook を所有できます。 * Webhook ごとの HTTP ヘッダーの合計サイズは、暗号化されたヘッダーで 2048 バイト、暗号化されていないヘッダーで 2048 バイトに制限されています。各ヘッダー タイプについて、制限値は、設定されたすべてのヘッダー名および値の合計バイト サイズとなります。ヘッダーの数に制限はありません。 情報メモ2025 年 11 月 3 日より、レガシー イベント形式は新しい Qlik クラウド イベント形式に置き換えられました。すべてのレガシー イベントでは、レガシー イベント ペイロードとクラウド イベント ペイロードの両方を含む一時的なハイブリッド イベントが使用されます。データ統合イベントはクラウド イベントとして発行されるため、将来移行する必要はありません。Qlik Cloud でサポートされているイベントとイベント タイプの完全なリストについては、「[Webhook でサポートされているイベント タイプ](https://help.qlik.com/ja-JP/cloud-services/Subsystems/Hub/Content/Sense_Hub/Admin/mc-administer-webhooks-supported-events.htm)」を参照してください。新しい Qlik クラウド イベントの詳細については、「[Qlik コミュニティ: 新しいイベント形式への移行](https://community.qlik.com/t5/Official-Support-Articles/Qlik-Cloud-Webhooks-Migration-to-new-event-formats-is-coming/ta-p/2528660)」を参照してください。 ### Webhook のリクエスト構造 Webhook がイベントによってトリガーされると、Webhook 作成中に指定されたエンドポイントに HTTP JSON リクエストを送信します。このリクエストの構造は、イベント タイプ、タイムスタンプ、オブジェクト属性 などのイベント メタデータとペイロードの詳細を含みます。 #### Webhook リクエストの例: アプリケーション削除イベント アプリケーションが削除されたときに送信される JSON リクエストの例を次に示します。 リクエスト URL ``` https:///api/v1/webhooks/{id} ``` ヘッダー ``` { "Content-Type": "application/json", "X-Execution-Token: ", "Qlik-Signature": "446bd5e3f5b635f491d17557e4bec6ebc61b7bd2bc9cc7b612e4e", "User-Agent": "Qlik Webhook" } ``` [Body] (ボディ) ``` { "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 イベント](https://qlik.dev/apis/event/)」を参照してください。 #### 暗号化されたヘッダー Qlik Cloud は暗号化された HTTP ヘッダーをサポートしています。暗号化されたヘッダーを使用すると、機密性の高いメタデータをさらに保護できます。仕組み: * 暗号化されたヘッダー値: Webhook を構成するときに、Webhook 用に構成されたヘッダー値を暗号化できます。これにより、ベアラー トークンや API キーなどの資格情報が安全に保存され、処理されるようになります。Webhook シークレットは一度だけ書き込み可能です。一度保存すると、シークレットは表示も取得もできなくなるため、誤って公開されるリスクが軽減されます。 情報メモヘッダーはストレージで暗号化され、送信時には暗号化されません。 ## Webhook の作成 Webhook は次のユーザーが作成できます。 * 管理 アクティビティ センターからのテナント管理者。 * Qlik Automate インターフェイスからのすべてのユーザー。 Qlik Automate での Webhook の使用の詳細については、「[Webhook の操作](https://help.qlik.com/en-US/cloud-services/Subsystems/Sense_QlikAutomation/Content/Sense_QlikAutomation/working-with-automations/working-with-webhooks.htm) (英語のみ)」を参照してください。 次の手順を実行します。 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. クラウド イベント Qlik Cloud Webhooks サービスによって発行されるイベント ペイロード。一度有効にして保存すると、変更を元に戻すことはできません。 7. 証明書の失効を確認 有効にすると、Webhook 証明書が有効であり、失効していないことを確認します。 8. 必要に応じて、リクエストに追加する HTTP ヘッダーを追加します。ヘッダー値を暗号化するには、チェックボックスを選択します 情報メモセキュリティ上の理由から、暗号化されたヘッダーは編集できません。ヘッダーを削除するには、削除アイコンをクリックします。値を削除するには、削除アイコンをクリックして新しい値を入力します。 9. [イベント] で、Webhook をトリガーするシステム イベントを選択します。使用できるイベントは次のとおりです。 * 自動化イベント * API イベント * アプリケーション イベント * データ統合イベント * ユーザー イベント 10. [Create] (作成)をクリックします。 情報メモ未保存の変更がある状態で [キャンセル] をクリックすると、確認ダイアログが表示されます。変更を保存せずに閉じるには、 [破棄] をクリックします。 ## Webhook の管理 情報メモ Qlik Automate で作成された Webhook は、管理 アクティビティ センターでのみ表示できます。編集、削除、有効化、または無効化することはできません。 これらの Webhook を管理するには、Qlik Automate インターフェイスを使用します。 ### Webhook の並べ替えと検索 テーブル内の Webhook は次の方法で並べ替えおよび検索します。 * 並べ替えの順序を変更するには、列の上部にある the 上下矢印 icon をクリックします。 * 列の上部にある the フィルター icon をクリックして、Webhook を検索します。検索フィルターは、完全一致と部分一致を使用できます。 Webhook テーブル。 Webhook テーブル。 Webhook テーブル。 ![管理コンソール Webhook テーブル](https://help.qlik.com/ja-JP/cloud-services/Subsystems/Hub/Content/Resources/Images/mc-webhooks.png) ### Webhook をオンにするまたはオフにする 次の手順を実行します。 1. 管理 アクティビティ センターで、 [Webhooks] に移動します。 2. Webhook の横の the 詳細 icon をクリックします。 3. Webhook をオンにするには、 [有効化] を選択します。 4. Webhook をオフにするには、 [無効化] を選択します。 新しく作成された Webhook は既定で有効になっています。 ### Webhook の編集 次の手順を実行します。 1. 管理 アクティビティ センターで、 [Webhooks] に移動します。 2. 編集する Webhook で、the 詳細 icon をクリックします。 3. [編集] を選択します。 4. 編集して [保存] をクリックします。 情報メモ未保存の変更がある状態で [キャンセル] をクリックすると、確認ダイアログが表示されます。変更を保存せずに閉じるには、 [破棄] をクリックします。 ### Webhook の削除 次の手順を実行します。 1. 管理 アクティビティ センターで、 [Webhooks] に移動します。 2. 削除する Webhook を選択します。 3. [削除] をクリックします。 4. 削除を確定します。 情報メモ1 つ以上の Webhook を選択するまで、 [削除] ボタンは利用できません。操作バーには、選択されている Webhook の数が表示されます。 ### Webhook 履歴の表示 Webhook のイベント履歴は 7 日間保持されます。 次の手順を実行します。 1. 管理 アクティビティ センターで、 [Webhooks] に移動します。 2. Webhook の横の the Webhook メニューを展開するための下矢印 UI アイコン icon をクリックすると、イベント履歴が展開されます。 Webhook 履歴。 Webhook 履歴。 Webhook 履歴。 ![管理コンソール Webhook 履歴](https://help.qlik.com/ja-JP/cloud-services/Subsystems/Hub/Content/Resources/Images/mc-webhook-history.png) 3. イベント配信を手動で再配信するには、イベント行の the 再送信アイコン icon をクリックします。 4. イベント応答ペイロードを表示するには、イベント行の the ↓ icon をクリックします。 ペイロードには、アプリケーション ID、名前、日付と時刻などの詳細が表示され、過去のイベントのデバッグや監査に役立ちます。 イベント応答ペイロード。 イベント応答ペイロード。 イベント応答ペイロード。 ![管理コンソールの Webhook イベント タイプのペイロード情報](https://help.qlik.com/ja-JP/cloud-services/Subsystems/Hub/Content/Resources/Images/mc-webhook-payload.png)