Webhook は、イベントが発生したときに実行されるコードです。Advocate では、Webhook を使用して URL を登録できます。これにより、プログラム内でイベントが発生するたびに、その URL に対して POST を送信します。たとえば、新しい参加者に対して特典クーポンコードが作成されたとき、event オブジェクトが作成されます。Webhook の作成と管理には 2 つの方法があります: Advocate API 経由で または Advocate プラットフォーム上で行います。このヘルプ記事では、Advocate プラットフォームを通じて Webhook を管理する方法を説明します。
上部のナビゲーションバーから、 [ユーザープロフィール] → [設定].
左側の列で、 Advocate 設定の下にある Webhook.
で Webhook サブスクリプション ページを開き、 サブスクリプションを作成.
の下に、 URL に投稿と入力します。ここには、特定のイベントに関するリアルタイム更新を送信するためにアプリケーションが使用する一意のアドレスを入力します。
必要に応じて、 Webhook 名の下に、新しい webhook サブスクリプションの名前を入力します。
次を選択します 保存.
プログラム内でイベントが発生するたびに Advocate が POST する URL を登録すると、ログを確認して、失敗した webhook イベントのトラブルシューティングを行えます。
Webhook ログにアクセスする
で Webhook サブスクリプション ページを開き、 ログを表示.
以下のフィルターを使用して Webhook イベントログ Webhook を絞り込みます。
詳細は以下の フィルターリファレンス を参照してください。
タイプ
Webhook の イベントタイプで絞り込みます。このフィルターの既定値は すべてのタイプ.
期間
Webhook が最後に更新された期間で絞り込みます。このフィルターの既定値は 全期間.
Webhook の詳細を表示する
特定の webhook を選択して、 Webhook 詳細 ビューを開きます。
このビューには、Webhook サブスクリプションのトラブルシューティングに使用できる情報が表示されます。
詳細は以下の イベント参照 を参照してください。
Webhook イベントタイプ.
Webhook ID
Webhook の一意の識別子です。
作成日
Webhook が作成された日付です。
イベントデータ
Webhook ペイロード.
サブスクリプション
Webhook が送信されたサブスクリプションとそのステータスです。
サブスクリプション詳細
Webhook サブスクリプションのエンドポイントから受信したレスポンスの詳細です。詳細には、Webhook の配信試行、試行のタイムスタンプ、送信先から受信した HTTP ステータスコード、送信先サーバーからの応答受信に時間がかかりすぎたために試行がタイムアウトしたかどうかが含まれます。
失敗したイベント配信のための Webhook 再試行システム
Rest hook は、イベントがトリガーされた直後に配信されます。エンドポイントが配信試行に正常に応答しない場合（つまり、200 以外のステータスコードを返した場合）、その配信は失敗と見なされます。
失敗した配信は、成功するか 72 回の試行が行われるまで、前回の失敗後 1 時間ごとに再試行されます（1 時間に 1 回の再試行の場合、約 3 日）。
継続的にエラーを返す webhook エンドポイントは、次のエラー数に達すると自動的に無効になります:
4xx エラー
1000
5xx エラー
2000
3xx エラー
最終更新 5 日前
役に立ちましたか？
