Webhookについて
Webhookを使って、情報を、JSON、XML、およびフォームエンコードされたHTTPリクエストを受け付けるサードパーティサービスおよびREST APIに渡すことができます。また、Webhookを使って、任意のURLにURLパラメータを渡すこともできます。
Webhookは、チケットが特定の条件を満たしたときに、ZendeskSupportの自動化とトリガによって使用されます。Webhookが重要なのは、サードパーティのサービスからのHTTPレスポンスに基づいて、トリガや自動化がアクションを起こすための手段となるからです。
利用可能なコンテンツのプレースホルダのいずれかを使用して、HTTPリクエストにチケットデータを挿入できます。
ビジネスルールがWebhookを起動すると、実行するジョブがキューに入りますが、実際にはすぐにジョブを実行するわけではありません。Webhookジョブは独立して実行されるため、Webhookが特定の順序で実行される保証はありません。
Webhookのリクエストは、エンドポイントが特定のHTTPレスポンスコードを返した場合、自動的に最大3回まで再試行されます。ターゲットとは異なり、リクエストが連続して失敗してもWebhookは無効になりません。再試行シナリオの詳細と例については、開発者向けドキュメントの「Monitoring webhooks(Webhookの監視)」を参照してください。
Webhookの作成
Webhookを作成するには
- 管理センターで、サイドバーにある「
アプリおよびインテグレーション」をクリックし、「Webhook」>「Webhook」を選択します。
- 「アクション」をクリックし、「Webhookを作成する」を選択します。
- サードパーティのサービスやシステムと統合できるようにWebhookを設定します。
詳細については、「Webhookのエンドポイント」および「Webhookの認証」を参照してください。
- (オプション)「Webhookをテスト」をクリックして、期待どおりに動作していることを確認します。
- 「次へ」をクリックして、WebhookをSupportのトリガまたは自動化に接続します。これは、Zendesk Supportの管理インターフェイスで行います。
- 管理センターの「Webhookを作成する」ページに戻り、「設定を完了」をクリックします。
Webhookを作成してトリガまたは自動化に接続したら、管理センターの「Webhook」ページからWebhookの詳細、イベントサブスクリプション、アクティビティをすべて確認できます。詳細については、「管理センターでのWebhookの管理」を参照してください。
Webhookのエンドポイント
Webhookは、作成時に指定したエンドポイントURLからリクエストを送信し、レスポンスを受信します。これにより、サードパーティのサービス、API、およびシステムとの統合が行われます。
エンドポイントURLは、https://www.yourdomain.com/path
の形式で指定します。
必須ではありませんが、セキュアHTTP(HTTPS)の使用を推奨します。セキュアなエンドポイントURLを提供することで、認証を有効にし、データを安全に渡すことができます。
Webhookの認証
- なし:認証が設定されておらず、要求されません。
- 基本認証:ユーザー名とパスワードを使用してWebookを認証します。
- ベアラートークン:OAuthアクセストークンを使用してWebhookを認証します。
Webhook認証についての開発者向け情報は、「Webhook security and authentication(Webhookのセキュリティと認証)」を参照してください。
Webhookをトリガや自動化に接続する
Webhookを使用するには、トリガや自動化に接続する必要があります。トリガや自動化は、Webhookの呼び出しが行われる状況を指定します。
WebhookをSupportのトリガに接続するには
Webhookをテストする
管理センターでは、さまざまなイベントソースやリクエストを使ってWebhookをテストすることができます。テスト専用の既存のWebhookにアクセスするだけでなく、作成中または編集中にWebhookをテストすることもできます。
Webhookをテストするには
- 管理センターで、サイドバーにある「
アプリおよびインテグレーション」をクリックし、「Webhook」>「Webhook」を選択します。
- リストでWebhookを見つけ、Webhookの行にあるオプションメニューアイコン(
)をクリックして、「Webhookをテスト」をクリックします。
- 「Webhookをテスト」パネルで、「イベントソースをテストする」選択します。これは、添付のトリガまたはエンドポイントURLのテストに使用できるサンプルチケットです。
- テストリクエストの詳細情報(リクエストボディ、パラメーター、ヘッダなど)を入力します。
- 「テストを送信」をクリックします。レスポンスは、テストリクエストの下のパネルに表示されます。
0 コメント
サインインしてコメントを残してください。