Skip to main content
Webhookは、注文処理が完了または失敗した際にサーバーへ HTTP POST コールバックを送信します。注文の取得 エンドポイントを繰り返しポーリングする代わりにWebhookを使用すると、結果が準備でき次第すぐに通知を受け取ることができます。

Webhookの設定

1

Webhookエンドポイントの登録

APIまたは BIZ MORI ダッシュボード からWebhookエンドポイントを作成できます。APIを使って作成するには、Webhookの作成 エンドポイントを使用します:
レスポンス:
secret はすぐに保存してください — 一度だけ表示され、再度取得することはできません。受信するすべてのWebhook署名の検証に必要です。
テスト注文のイベントを受信するには、isTest: true のテスト Webhook エンドポイントを作成します。テスト API キーは同じ所有者のテストエンドポイントだけを管理できます。本番モードと別所有者のリソースは公開されません。詳しくは テスト API キー を参照してください。
2

エンドポイントの実装

Webhookハンドラーは次を実行する必要があります:
  • JSON本文で POST リクエストを受け付ける
  • 5秒以内2xx ステータスコードで応答する
  • 処理前に X-MoriBiz-Signature ヘッダーを検証する
3

署名の検証

すべてのリクエストには X-MoriBiz-Signature ヘッダーが含まれます。使用している言語での実装については、以下の 署名検証 を参照してください。

イベントタイプ

Webhookペイロード

すべてのWebhookペイロードは次の構造に従います:

完了イベント — 共通フィールド

失敗イベント — 共通フィールド

Anti-AI / watermark 埋め込み — 追加フィールド(完了)

watermark 抽出 — 追加フィールド(完了)

status フィールドは常に complete です。watermark が検出されたかどうかは statusCode で確認してください。

AI Detection — 追加フィールド(完了)

署名検証

X-MoriBiz-Signature ヘッダーを確認してWebhookの真正性を検証します。イベントを処理する前に必ず検証してください。

再送ポリシー

BIZ MORIは、信頼性の高いWebhook配信を保証するために多段階の再送システムを使用しています。

初期再送

エンドポイントが 2xx ステータスコードを返さない場合、BIZ MORIは直ちに再送を試みます:

スケジューラーベースの再送

初期再送がすべて失敗すると、イベントは間隔が徐々に広がるスケジューラーベースの再送キューに登録されます: スケジューラーベースの再送がすべて尽きると、イベントは FAILED としてマークされます。Webhookイベント一覧 エンドポイントを使用して、失敗したイベントを確認できます。

手動再送API

自動再送プロセスとは関係なく、再送APIを使用していつでも手動でWebhookを再送できます:

失敗通知メール

初回のWebhook配信に失敗すると、アカウント所有者にWebhook配信失敗の通知メールが送信されます。過剰な通知を防ぐため、このメールは1日最大1回のみ送信されます。

Webhookの管理