Spark!

Webhook

リアルタイムのイベント通知を受信

最終更新日:2026-01-19

WebhookはSpark!でイベントが起きるとアプリに通知します。新しい注文、アフィリエイター登録、支払いなどの更新をリアルタイムで受信できます。

Webhookの設定

  1. Settings → API → Webhooksに移動します
  2. "Add Webhook Endpoint"をクリックします
  3. エンドポイントURLを入力します(HTTPS必須)
  4. 受信するイベントを選びます
  5. 検証用の署名シークレットをコピーします

利用可能なイベント

  • affiliate.created — 新しいアフィリエイターが登録
  • affiliate.approved — アフィリエイターを承認
  • affiliate.updated — プロフィールが変更
  • order.attributed — 注文がアフィリエイターに紐づいた
  • commission.created — 報酬を計算
  • commission.approved — 報酬が確定
  • commission.paid — 報酬を支払済み
  • payout.created — 一括支払いを作成
  • payout.completed — 一括支払いを処理
  • click.recorded — アフィリエイトリンクをクリック

ペイロード形式

Webhookのペイロードは次を含むJSONオブジェクトです。

  • id — 固有のイベントID
  • type — イベントの種類("order.attributed"など)
  • created_at — ISO 8601タイムスタンプ
  • data — イベント固有のデータオブジェクト
冪等性

idフィールドで重複を排除します。まれに同じイベントが複数回届く場合があります。

Webhookの検証

真正性のため署名を確認します。

  1. X-Spark-Signatureヘッダーを取得します
  2. 署名シークレットで生の本文のHMAC-SHA256を計算します
  3. 計算した署名とヘッダー値を比較します
  4. 一致しないリクエストを拒否します

再試行の方針

エンドポイントが失敗した場合(2xx以外の応答)、Spark!は次の時点で再試行します。

  • 直後
  • 5分後
  • 30分後
  • 2時間後
  • 24時間後

5回失敗するとWebhookは失敗として記録されます。

Webhookのテスト

エンドポイントをテストします。

  • 設定の"Send Test Event"ボタンを使います
  • 配信ログを確認します
  • 失敗した配信を手動で再試行します

次のステップ

このページは役に立ちましたか?

さらにサポートが必要ですか? サポートに問い合わせる