IBM Cloud Docs
Webhook

Webhook

Webhook は、着信通知をプログラマチックにコンシュームできるサービス宛先を表します。 例えば、イベントに関する着信通知は、着信通知の内容に基づいて動作するバックエンドマイクロサービスへのWebhook宛先をトリガすることができます。

Webhook 宛先の構成

Destinations」タブで Webhook 宛先を構成できます。 構成の一部として、Webhook URL と、Webhook の呼び出し時に呼び出される REST API 動詞を入力します。 宛先 Webhook に許可ヘッダーを入力することもできます。 サブスクリプションを作成して、Webhook 宛先をトピックに関連付けます。

対応 HTTP 動詞

Event Notifications webhookはhttp動詞のGET、POST、PUT、PATCHをサポートしています。

  • GET : 指定されたリソースの表現を取得する。
  • POST : 新しいリソースを作成します。
  • PUT : リソース全体を提供されたデータで置き換える。
  • PATCH : リソースの部分的な変更を適用する。

Webhook 署名

着信通知が IBM Cloud Event Notifications からのものであることを識別するために、Webhook 署名を有効にすることができます。 署名が有効になっている場合、公開鍵がダウンロードされ、受信通知コンテンツを復号化するために使用できる。

IPアドレスの一覧表示

IP アドレスの範囲を許可リストに登録して、Webhook を受信するサーバーへのアクセスを制限できます。 詳細については、 ウェブフックのIPアドレス をご覧ください。

イベント通知サービス・インスタンスの場所に関係なく、Web フックのトラフィックが中断されないようにするには、すべてのリージョンの IP 範囲を許可リストに追加する必要があります。

Webhook 再試行ポリシー

Webhook を呼び出すときに、ネットワーク・エラーやアプリケーションの欠陥などの問題が原因で要求が失敗することがあります。 再試行は、外部要求に対する回復力を提供するために使用されます。 このような状況では、以下の値を使用して要求を再試行してください。

  • 制限 = 60 秒: サービスが再試行する合計時間。
  • ステップ = 5 秒: 各障害の後、サービスは 5 秒待機してから再試行します。 この遅延により、外部サービス (Webhook) の爆撃を防ぐことができます。

さらに、以下のタイムアウト条件により、Webhook 呼び出しが失敗します。

  • 10 秒の接続タイムアウト
  • 60 秒の応答タイムアウト

再試行後も Webhook URL への呼び出しが失敗すると、通知は失われます。