ウェブフック

Webhookイベントハンドラを作成することで、サポートされているシステムイベントに関する情報を受け取ることができます。

たとえば、webpageテンプレートを持つアイテムが作成されたときに、指定したエンドポイントにリクエストを送信するようにWebhookイベントハンドラを設定できます。

アイテムがワークフローの状態を変更したとき、またはワークフロー コマンドが実行されたときに 、Webhook送信アクションを追加することで情報を受け取ることができます。

たとえば、Webhook送信アクションをワークフローの承認済み状態に挿入できます。その後、ワークフローを使用しているアイテムがapproved状態に移行すると、Webhookは指定されたエンドポイントにHTTPリクエストを送信します。

Webhook検証アクションを追加することで、アイテムのワークフロー状態の変更を承認または拒否する機能をサード パーティ サービスに提供できます。Webhook検証アクションが要求を送信すると、サードパーティ サービスは応答を返す必要があります。

たとえば、状態をin reviewからapprovedに変更するワークフローのコマンド項目にWebhook検証アクションを追加できます。コマンドが実行されると、Webhookは指定されたエンドポイントにHTTP要求を送信します。

その後、エンドポイントはコマンドを検証する応答を返す必要があります。エンドポイントがコマンドを検証しない場合、項目の状態は変更されません。

宛先エンドポイントで認証が必要な場合は、認証アイテムを作成してWebhookに割り当てる必要があります。

リクエストの送信時にエラーが発生した場合は、ログファイルでエラー情報を確認してください。

特定のリクエストですべてのWebhookを送信するデフォルトの最大時間は10秒です。

エンドポイントを設定していない場合は、WebhookテストWebサイトを使用して、Webhookをテストするエンドポイントを作成できます。