ウェブフックを編集、回転、無効化、または削除する

Notiondesk ウェブフックエンドポイントの URL、名前、イベントを変更したり、署名シークレットをローテーションしたり、無効化または有効化したり、削除したりできます。

1 分で読めます

エンドポイントは、そのページからいつでも変更できます。URL、名前、イベントの編集、署名シークレットのローテーション、一時的な無効化、削除などが可能です。

簡単な方法: [設定] > [開発者] > [Webhook]に移動し、エンドポイントをクリックします。編集して[変更を保存]をクリックするか、 [その他の操作] ( ... ) を使用して無効化または削除します。

始める前に

あなたはワークスペースの所有者または管理者です。その他の役割のユーザーはWebhookページを開くことができません。

エンドポイントを編集する

  1. 設定 > 開発者 > Webhookに移動し、エンドポイントをクリックします。
  1. URLまたは名前を変更してください。
  1. 「イベント」の下にある「イベントを追加」をクリックするとイベントを追加できます。イベントを削除するには、イベントの横にある×印をクリックします。少なくとも1つのイベントは残しておいてください。
  1. 「変更を保存」をクリックしてください。

新しいイベントは更新された設定を使用します。URLを変更すると、失敗回数はリセットされ、既に予定されている再試行は新しいURLに送信されます。

署名シークレットをローテーションする

情報が漏洩した可能性がある場合、または紛失した場合は、秘密情報をローテーションしてください。

  1. エンドポイントページの「署名シークレット」の下にある「ローテーション」をクリックします。
  1. 確定するには「回転」をクリックしてください。
  1. 「コピー」をクリックし、新しいシークレットをサーバーに保存してから、 「保存しました」をクリックします。
古いシークレットはすぐに無効になります。ローテーション後に送信されるすべてのリクエスト(再試行を含む)は新しいシークレットで署名されるため、サーバーも同時に更新してください。

Webhook が Notiondesk から来ていることを確認すると、サーバーがシークレットをどのように使用するかが示されます。

エンドポイントを無効化または有効化する

エンドポイントを削除せずにイベントの送信を停止するには、エンドポイントを無効化します。たとえば、サーバーの作業中に使用します。

  1. エンドポイントのページで、 [その他の操作] ( ... ) をクリックします。
  1. 「無効にする」をクリックしてください。

エンドポイントは「無効」と表示されます。無効になっている間は、次のようになります。

  • イベントを受信しません。その間に発生したイベントは保存されず、再度有効にした後でも送信されることはありません。
  • 既に予定されていた再試行はキャンセルされます。
  • 「テストイベントを送信」をクリックすることは可能です。

再度有効にするには、 「その他の操作」 ( … )をクリックし、 「有効にする」をクリックします。すると、新しいイベントが再び受信され、失敗回数がリセットされます。

エンドポイントに「一時停止」と表示されている場合、Notiondesk が度重なる失敗の後、エンドポイントをオフにしました。サーバーが正常に動作するようになったら、 「再開」をクリックしてください。エンドポイントが一時停止する理由については、 「Webhook 配信の確認と失敗の修正」を参照してください。

エンドポイントを削除します

  1. エンドポイントのページで、 [その他の操作] ( ... ) をクリックします。
  1. 「削除」をクリックしてください。
  1. 確定するには「削除」をクリックしてください。
削除操作は元に戻せません。エンドポイントの配信ログも削除され、キューに登録されたイベントは送信されません。

よくある質問

エンドポイントが無効になっている間、イベントは失われますか?

はい。無効化されている間に発生したイベントは送信されません。URLまたはイベントのみを変更する必要がある場合は、エンドポイントを編集してください。

回転後に以前の署名秘密鍵を見ることはできますか?

いいえ。各シークレットは、エンドポイントを追加またはシークレットをローテーションしたときに一度だけ表示されます。エンドポイントページには、そのシークレットの最初の数文字のみが表示されます。

イベントを変更すると、過去の配送に影響はありますか?

いいえ。過去の配信履歴は「最近の配信履歴」に残ります。保存後に発生したイベントのみが新しいリストに表示されます。

削除したエンドポイントを復元できますか?

いいえ。同じURLとイベントを持つ新しいエンドポイントを追加してください。新しい署名シークレットが発行されます。

関連する記事

このページは役に立ちましたか?

Still need help? Ask us