ウェブフックについて
管理画面＞ウェブフック から、「新規作成」ボタンを押すと設定できます。
各項目の設定方法は以下を参照してください。
- URL：システム通知を受信するURLを入力する
- 利用店舗を指定する：有効にして店舗を選択する
- トリガー：システム通知を受信したい処理を選択する
※設定後、ページ下部の「作成」ボタンを押してください
ウェブフック失敗により、自動停止された可能性があります。
以下の場合、ウェブフックを自動で停止します。
|
HTTPレスポンス エラーコード
|
処理
|
|---|---|
|
3xx
|
リトライせず、失敗後即停止する
|
|
4xx、500、501、502
|
初回含む最大10回のリトライを行い、最大回数に達すると停止する
|
停止後はリトライされないため、もう一度有効化したい場合は管理画面から以下手順で設定する必要があります。
①管理画面＞ウェブフック から、「すべて」または「停止」のウェブフック一覧を表示
②有効化したいウェブフックを選択
③画面左下の「有効化」ボタンを押す
ウェブフックの失敗時および停止時にメール通知が必要な場合は、管理画面＞一般設定＞一般＞通知 の「ウェブフック失敗時の通知」「ウェブフック利用不可の通知」を有効にしてください。
失敗した理由は、管理画面＞ウェブフック＞対象のウェブフックを選択＞最近のイベント から対象のトリガーを選択し、「error_message」から確認できます。
例）error_message：Request timeout to www.triple-farm.com after 3 seconds
……指定されたURLに対してウェブフック通知した際に、3秒以内にレスポンスがない場合、当社ではタイムアウトによって「失敗」と判定します。そのため、非同期処理によって3秒以内にレスポンスを返却する実装が必要です。
※あくまで当社の判定なため、加盟店さまへは結果通知が届いてる場合があります
ウェブフック失敗後の挙動は、利用ガイド『ウェブフック』を参照してください。
