ワークフロー用 Webhook の作成
Webhook は、Qlik Cloud システム イベントをワークフローのトリガーとして使用する方法を提供します。Webhook を作成すると、定義されたシステム イベントが発生するたびに JSON リクエストが自動的に Webhook エンドポイントに送信されます。Webhook を使用すると、送信 JSON データを受信できるアプリケーションにイベント データを送信できます。
テナントが新しいナビゲーション エクスペリエンスを使用している場合は、管理コンソール は管理アクティビティ センターに置き換えられます。
詳細は、新しいプラットフォーム ナビゲーションをご覧ください。
Webhook プロパティ
Webhook を作成するには、Webhook およびエンドポイント プロパティを構成し、Qlik Cloud イベント タイプを選択する必要があります。
プロパティ | 説明 |
---|---|
名前 | Webhook の名前。 |
説明 (任意) | Webhook の説明。 |
[URL] | Webhook エンドポイント用 URL。URL (Webhook エンドポイント) は完全修飾ドメイン名 (FDQN) であり、HTTPS プロトコルを使用する必要があります。エンドポイlントを IP アドレスにすることはできません。 |
シークレット (オプション) | Webhook 認証用シークレット。シークレットは、最小 32 文字、最大 64 文字である必要があります。Webhook シークレットを作成すると、そのシークレットは qlik-signature として HTTP リクエストに追加されるハッシュの一部になります。 |
ヘッダー (オプション) |
HTTP リクエストに追加できるヘッダー。 |
各 Webhook は、1 つ以上のイベント タイプを使用して構成されます。
リソース | イベント タイプ |
---|---|
アプリ | 作成済み、削除済み、データ更新済み、リロード済み、公開済み、エクスポート済み 情報メモデータ更新イベントは、更新されたデータを参照します。リロード イベントは、Qlik Sense app とリロードされた関連するデータ テーブルを参照します。 |
ユーザー | 作成済み、削除済み |
Webhook は、いずれかのイベントが発生するまで待機し、イベントが発生するとイベント データを Webhook エンドポイントに送信します。データは、エンドポイント URL に JSON リクエストとして受け渡されます。
アプリ削除イベント タイプ用 JSON リクエスト
Request
URL
https://api.blendr.io/v1/widgets/F502987A-AF89-4992-8127-F28794C5A74A?X-Execution-Token=xxxxx
Headers
{
"Content-Type": "application/json",
"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
}
}
}
Webhook の作成
管理コンソール から Webhook を作成します。Qlik アプリケーションの自動化インターフェースから Webhook を作成することもできます。詳しくは、[Webhook の操作 (英語のみ)] を参照してください。
各テナントに作成可能な Webhook の最大数は 100 です。
次の手順を実行します。
-
管理コンソール で、[Webhook] に移動します。
-
右上にある [新規作成] をクリックします。
-
[Webhook の作成] ダイアログ ボックスで、Webhook の名前を入力します。
-
オプションの説明を追加します。
-
サードパーティ統合アプリケーションの URL を入力します。
-
任意で、HTTP リクエストに追加するシークレットを入力します。
-
任意で、リクエストを追加する HTTP ヘッダーを追加します。
-
[イベント] で、Webhook のイベント タイプを選択します。
-
終了したら、[作成] をクリックします。
Webhook がテーブル内に一覧表示されます。新規作成された Webhook はデフォルトで有効になっています。
![クリックしてフル サイズを表示 管理コンソール Webhook テーブル](../../Resources/Images/mc-webhooks.png)
Webhook の編集
次の手順を実行します。
-
管理コンソール で、[Webhook] に移動します。
-
編集する Webhook の行末の
ボタンをクリックします。
-
[編集] をクリックします。
編集パネルには、Webhook 構成変更用のオプションが表示されます。
-
編集して [保存] をクリックします。
Webhook の削除
次の手順を実行します。
-
管理コンソール で、[Webhook] に移動します。
-
削除する Webhook を選択します。
-
右上にある [削除] をクリックします。
-
ポップアップ ダイアログが開き、選択を確認します。[削除] をクリックします。
Webhook 履歴の表示
管理コンソール の [Webhook] で、Webhook 履歴にアクセスします。
-
Webhook 履歴を表示するには、Webhook 行末の
ボタンをクリックします。
Webhook 履歴が表示されます。
-
イベント配信を手動で再配信するには、イベント行末の
ボタンをクリックします。
-
イベント応答ペイロードを表示するには、イベント行末の
ボタンをクリックします。