Webhookの管理

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

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

Webhookを管理するには、管理者であるか、またはトリガの管理権限のあるカスタムロールのエージェントである必要があります。

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

• Webhookを編集および管理する
• Webhookのアクティビティを表示する
• Webhookをデバッグする

Webhookを編集および管理する

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

Webhookを編集するには

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

   すべてのフィールドは編集可能です。ただし、認証を使用する場合、Webhookを作成または更新した後は、キー、トークン、またはパスワードを見ることはできなくなります。カスタムヘッダーを削除するには、削除アイコン（）をクリックします。

4. （オプション）Webhookに加えた変更をテストします。
5. 「保存」をクリックします。

Webhookを複製するには

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

ブランドを非アクティブにするには

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

Webhookを削除するには

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

Webhookのアクティビティを表示する

各Webhookにはアクティビティ記録があり、呼び出しの詳細な記録に加えて、過去7日間のリクエスト数を確認することができます。

エンドポイントが特定のHTTPレスポンスコードを返した場合、Webhook呼び出しは最大3回まで自動的に再試行されます。再試行シナリオの詳細と例については、開発者向けドキュメントの「Webhook retry logic」を参照してください。

Zendeskは、Webhookにアクションを配信するのは一度だけになるように努めています。ただし、保証することはできません。同じアクションが複数回Webhookに呼び出される可能性があります。重複した呼び出しを検出するには、Webhook署名を使用することができます。ワークフローに問題がある場合は、Webhookから生じるアクションが冪等であることを確認してください。

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

Webhookをデバッグする

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

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

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

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

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