ウェブフック

「ウェブフック」は、各種処理結果について、加盟店さま当サービスからシステム通知を受信する必要がある場合に設定します。

※ウェブフックはベストエフォートのため、通知の成功や通知速度を保証するものではございません。
決済の結果を受け短時間で加盟店のページなどで次の処理を行いたい場合は、APIのリクエストで課金情報の取得(課金:GET)、もしくはウィジェットのパラメータに記述を追加することでコールバックのイベントをリアルタイムで受け取ることを推奨しております。

追加方法について

• 「追加」を選択します。
• 「URL」でシステム通知を受信するURLを指定します。
• 特定の店舗の設定を行う場合は、「利用店舗を指定する」を有効にして店舗を選択します。
• 「トリガー」でどの処理結果についてシステム通知を受信するかを選択します。
• 通知するシステムに対して何らかの認証をヘッダーに記述する必要がある場合、「Authorizationヘッダー」で任意の値を指定することができます。指定した値は通知内容のヘッダー部分に反映されます。

各処理結果について

処理結果は、作成したウェブフックの「最新のイベント」から確認することができます。

各種処理結果の詳細は、下記ページにてご確認ください。
リファレンス > ウェブフック

処理結果は、「呼び出し」ボタンを押すことで再度送信することができます。

ウェブフックの失敗後の挙動（6/10より変更になった仕様）

ウェブフックの通知が失敗した場合、返却されたエラーコードによってリトライを行います。
失敗により停止したウェブフックは管理画面・もしくはAPIで再開する必要があります。

リトライ間隔は、1回目は1分でその後指数関数的に増加※し、最大は15分です。
※1分、2分、4分、8分、、と間隔が伸びていくこと

エラーコード	処理
2xx	成功のためリトライしない
3xx	リトライせず、失敗後即停止する
4xx、500-502	初回含む最大10回のリトライを行い、最大回数に達すると停止する
5xx（500-502以外） ※弊社側、加盟店さま側の3秒以上のレスポンスのタイムアウト時含む	初回含む最大10回のリトライを行い、最大回数に達しても停止しない

ウェブフックの失敗後の挙動（6/10以前の仕様）

下記の場合にウェブフックを自動で停止いたします。リトライは行われず、停止後は管理画面から手動で再開処理を行う必要がございます

• 3xx HTTPレスポンスコードを返した場合
• 4xx HTTPレスポンスコードを返した場合
• 500, 501, 502 HTTPレスポンスコードを返した場合

下記の場合はウェブフックが停止されません。

• 弊社側、加盟店様側の3秒以上のレスポンスのタイムアウト
• 2xx HTTPレスポンスコードを返した場合
• 5xx (500, 501, 502以外) HTTPレスポンスコードを返した場合

下記の場合は例外的に、１秒おきに1回のリトライを行います。

• 429, 503 HTTPレスポンスコードを返した場合

ウェブフック失敗・停止時のお知らせ機能について

管理画面の一般設定より、ウェブフックが失敗・停止された際にメール通知を受け取れる設定ができます。