API・統合

Webhookペイロード

Webhook Payload

要点:WebhookペイロードとはBrevoがWebhookのコールバックURLへ送信するJSON形式のデータ本体です。イベント種別・発生日時・対象メールアドレス・キャンペーンIDなどの情報が含まれており、外部システムでの処理に使用します。

Webhookペイロードとは

Webhookペイロードとは、Brevoがイベント発生時にコールバックURLへ送信するHTTP POSTリクエストの本体(ボディ)に含まれるJSON形式のデータです。たとえばメールが開封された場合、ペイロードにはイベント種別(event: "opened")・発生日時・対象の受信者メールアドレス・キャンペーンIDなどの情報が構造化されて含まれます。受信側のサーバーはこのデータを解析して必要な処理を実行します。

ペイロードの構成

Brevoのペイロードに含まれる主なフィールドは次の通りです。event(イベント種別)・email(受信者メールアドレス)・id(メッセージID)・date(イベント発生日時)・subject(件名)・ts_event(UNIXタイムスタンプ)などが標準的に含まれます。クリックイベントの場合はクリックされたURLも含まれます。イベント種別ごとに含まれるフィールドが異なる点に注意が必要です。

Brevoでの確認方法

Brevo管理画面の「Settings(設定)」→「Developers(開発者)」→「Webhooks(ウェブフック)」でWebhookのテスト送信機能を使うと、各イベント種別のサンプルペイロードを実際のコールバックURLへ送信できます。また、Brevoの公式ドキュメント(developers.brevo.com)にイベント別のペイロード仕様が詳細に記載されています。

注意点

注意: ペイロードの構造はイベント種別によって異なります。受信側プログラムではeventフィールドを最初に確認し、イベント種別に応じた処理分岐を実装してください。

ヒント: 受信したペイロードをそのままデータベースに保存しておくと、後から集計・再処理が可能になります。まずログを取る設計にしておくと安全です。

最終更新日:2026年5月22日
用語集一覧へ戻る