管理センターでのWebhookの作成

ファストパス：管理センター >「アプリおよびインテグレーション」>「Webhook」>「Webhook」

Webhookは、Zendesk Supportのトリガや自動化の実行などのイベントへの応答として、指定されたURLにHTTPリクエストを送信します。Web開発者は、webhookを使用して別のシステムでの動作を呼び出します。

メモ：トライアルアカウントのWebhookは最大10個に制限されています。

この記事では、次のトピックについて説明します。

Webhookについて
webhookの作成
Webhookをテストする

Webhookについて

Webhookは、サードパーティのサービスやバックエンドシステムとの統合に使用されます。たとえば、Webhookを使って以下のようなことができます。

緊急のチケットが作成された場合に、Slackでチームに警告する
チケットを解決した後、チケットの情報をAsanaのドキュメントチームに渡す
重要なチケットイベントに関して、自社のバックエンドサービスに通知する

Webhookを使って、情報を、JSON、XML、およびフォームエンコードされたHTTPリクエストを受け付けるサードパーティサービスおよびREST APIに渡すことができます。また、Webhookを使って、任意のURLにURLパラメータを渡すこともできます。

Webhookは、チケットが特定の条件を満たしたときに、ZendeskSupportの自動化とトリガによって使用されます。Webhookが重要なのは、サードパーティのサービスからのHTTPレスポンスに基づいて、トリガや自動化がアクションを起こすための手段となるからです。

利用可能なコンテンツのプレースホルダのいずれかを使用して、HTTPリクエストにチケットデータを挿入できます。

Webhookのリクエストは、エンドポイントが特定のHTTPレスポンスコードを返した場合、自動的に最大3回まで再試行されます。ターゲットとは異なり、リクエストが連続して失敗してもWebhookは無効になりません。

webhookの作成

Webhookの作成は2つ手順で行います。まず、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の認証

Webhookがセキュアなエンドポイントと統合している場合、WebhookおよびWebhookが送信するデータを認証するためのオプションが4つあります。エンドポイントの認証要件についてサードパーティのドキュメントを参照するか、またはチーム内の開発者と協力してWebhookに適した認証方法を選ぶことができます。

なし：認証が設定されておらず、要求されません。
基本認証：ユーザー名とパスワードを使用してWebookを認証します。
ベアラートークン：OAuthアクセストークンを使用してWebhookを認証します。

Webhook認証についての開発者向け情報は、「Webhook security and authentication（Webhookのセキュリティと認証）」を参照してください。

Webhookをトリガや自動化に接続する

Webhookを使用するには、トリガや自動化に接続する必要があります。トリガや自動化は、Webhookの呼び出しが行われる状況を指定します。

WebhookをSupportのトリガに接続するには

管理センターで、サイドバーにあるオブジェクトとルールアイコン（）をクリックし、「ビジネスルール」>「トリガ」を選択します。
メモ：Webhookを作成または編集する場合は、「ビジネスルールの管理」をクリックします。
トリガまたは自動化を新規作成するか、オプションアイコン（）にカーソルを合わせて「編集」をクリックして、既存のものを編集します。
トリガの場合、「アクション」で「アクションを追加」をクリックします。「アクティブなWebhookを通知する」を選択し、Webhookを選択します。「保存」をクリックします。

WebhookをSupportの自動化に接続するには

管理センターで、サイドバーにあるオブジェクトとルールアイコン（）をクリックし、「ビジネスルール」>「自動化」を選択します。
メモ：Webhookを作成または編集する場合は、「ビジネスルールの管理」をクリックします。
トリガを新規作成するか、またはオプションアイコン（）にカーソルを合わせて「編集」をクリックし、既存のトリガを編集します。
自動化の場合は、「これらのアクションを実行」で、アクションの追加アイコン（）をクリックします。「通知:アクティブなWebhookを通知する」を選択して、Webhookを選択します。「送信」をクリックします。

Webhookをテストする

管理センターでは、さまざまなイベントソースやリクエストを使ってWebhookをテストすることができます。テスト専用の既存のWebhookにアクセスするだけでなく、作成中または編集中にWebhookをテストすることもできます。

Webhookをテストするには

管理センターで、サイドバーにあるアプリおよびインテグレーションアイコン（）をクリックし、「Webhook」>「Webhook」を選択します。
リストでWebhookを見つけ、Webhookの行にあるオプションメニューアイコン（）をクリックして、「Webhookをテスト」をクリックします。
「Webhookをテスト」パネルで、「イベントソースをテストする」選択します。これは、添付のトリガまたはエンドポイントURLのテストに使用できるサンプルチケットです。
テストリクエストの詳細情報（リクエストボディ、パラメーター、ヘッダなど）を入力します。
「テストを送信」をクリックします。レスポンスは、テストリクエストの下のパネルに表示されます。