Webhookの管理

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

Webhookは、「Webhook」ページからZendesk管理センターで作成され、管理されます。

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

Webhookを編集および管理する
Webhookのアクティビティを表示する（ベータ版）
Webhookをデバッグする

管理センターでWebhookにアクセスするには

管理センターで、サイドバーにある「 アプリおよびインテグレーション」をクリックし、「Webhook」>「Webhook」を選択します。
「Webhook」ページでは、各Webhookの詳細情報を確認できます。

Webhookを編集および管理する

多くの場合、管理者はWebhookの編集、複製、非アクティブ化、削除を行うことができます。ただし、アプリの要件によって作成されたWebhookは、編集は可能ですが、複製や削除はできません。アプリの要件によって作成されたWebhookは、アプリの開発者が変更することが可能で、アカウント管理者による変更よりも優先させることができます。

Webhookを編集する

管理センターで、サイドバーにある「 アプリおよびインテグレーション」をクリックし、「Webhook」>「Webhook」を選択します。
リストでWebhookを見つけ、Webhookの行にあるオプションメニューアイコン（）をクリックして、「編集」をクリックします。
「詳細」タブで、必要に応じてWebhookを修正します。
（オプション）Webhookに加えた変更をテストします。
「保存」をクリックします。

Webhookを複製する

管理センターで、サイドバーにある「 アプリおよびインテグレーション」をクリックし、「Webhook」>「Webhook」を選択します。
リストでWebhookを見つけ、Webhookの行にあるオプションメニューアイコン（）をクリックして、「複製」をクリックします。
Webhookの名前を編集し、必要に応じてWebhookを変更します。
「更新」をクリックします。

Webhookを非アクティブにする

管理センターで、サイドバーにある「 アプリおよびインテグレーション」をクリックし、「Webhook」>「Webhook」を選択します。
リストでWebhookを見つけ、Webhookの行にあるオプションメニューアイコン（）をクリックして、「非アクティブにする」をクリックします。
確認ダイアログで、「非アクティブにする」をクリックします。

Webhookを削除する

管理センターで、サイドバーにある「 アプリおよびインテグレーション」をクリックし、「Webhook」>「Webhook」を選択します。
リストでWebhookを見つけ、Webhookの行にあるオプションメニューアイコン（）をクリックして、「削除」をクリックします。
「削除」をクリックします。

Webhookのアクティビティを表示する（ベータ版）

ヒント：Webhookのアクティビティログは、ベータ版として公開されています。何らかの理由でアカウントが別のポッドに移動した場合、過去7日間のすべてのWebhookのアクティビティ記録が削除されますのでご注意ください。

各Webhookにはアクティビティ記録があり、呼び出しの詳細な記録に加えて、過去7日間のリクエスト数を確認することができます。なお、Webhookの呼び出しは、失敗となるまでに自動的に3回再試行されます。

管理センターで、サイドバーにある「 アプリおよびインテグレーション」をクリックし、「Webhook」>「Webhook」を選択します。
リストでWebhookを見つけ、Webhookの行にあるオプションメニューアイコン（）をクリックして、「詳細を表示」をクリックします。
「アクティビティ」タブをクリックします。
「フィルター」をクリックして、アクティビティ記録を開始日、開始時間、終了日、終了時間、またはステータスでフィルタリングした後、「フィルターを適用」をクリックします。

Webhookをデバッグする

Webhookが正常に動作していない場合、失敗した呼び出しはWebhookのアクティビティ記録に表示されます。アクティビティ記録は、「すべて失敗」というステータスや特定のエラーの種類でフィルタリングできます。「アクティビティ」タブでは、「呼び出しID」をクリックして、特定のWebhook呼び出しのリクエストとレスポンスを表示することもできます。

レスポンスはほとんどの場合、Zendesk自身からではなく、Webhookのリクエストを受けたサードパーティーのサービスから送信されます。通常、エラーを修正するためにはこのサードパーティのサービスとの連携が必要です。

レスポンスステータスに含まれる数値コードを使用して、問題を診断することができます。これらのレスポンスステータスコードは、HTTPリクエスト全体で標準です。標準のHTTPレスポンスステータスコードの一覧とその意味については、MDN web docsのHTTPレスポンスステータスコードを参照してください。

メモ：サービスが独自のHTTPレスポンスステータスコードを使用している場合、そのサービスのドキュメントを参照する必要があるかもしれません。

Webhookのリクエストには10秒のタイムアウトがあります。レスポンスステータス「Failed: 504 Gateway Timeout」は、サービスがこのタイムアウト時間内にWebhookのリクエストに応答しなかったことを示します。タイムアウト時間は調整できません。