Webhookデータ構造（Apps API）

Webhookで通知されるイベントの共通的なデータ構造と、各種オブジェクトについて解説します。

イベント共通データ構造

すべてのWebhookイベントは、以下の共通データを含むJSON形式で通知されます。

{
  "id": "リクエストID（UUID）",
  "event": "イベント名",
  "mode": "live（本番環境）またはtest（テスト環境）",
  "create_at": "イベント発生日時（ISO-8601形式・JST）",
  "customer": { 顧客情報オブジェクト（任意） },
  "payment": { 決済情報オブジェクト（任意） },
  "plan": { プラン情報オブジェクト（任意） },
  "discord": { Discord連携情報オブジェクト（任意） },
  "line": { LINE連携情報オブジェクト（任意） },
  "shipping": { お届け先情報オブジェクト（任意） },
  "remarks": [ 備考欄オブジェクト（任意） ],
  "utm": [ UTMパラメータオブジェクト（任意） ]
}

顧客情報オブジェクト（customer）

{
  "customer_id": "顧客の一意なID（UUID）",
  "email": "メールアドレス",
  "name": "顧客名（任意）",
  "company": "会社名（任意）",
  "phone_number": "電話番号（E.164形式・任意）"
}

決済情報オブジェクト（payment）

{
  "platform_id": "決済プラットフォームID",
  "original_price": "割引前の金額または割引前の総支払金額（1回払い・定期払いのみ）",
  "total_price": "割引後の総支払金額（定期払いのみ）",
  "price": "決済金額",
  "charge_id": "プラットフォーム決済ID（任意）",
  "refund_id": "返金ID（任意）",
  "installments": "分割回数（毎月払いのみ）",
  "installment_index": "今回の支払い回数（毎月払いのみ）"
}

※「installments」「installment_index」は2025年6月27日より毎月払いのpaymentオブジェクトに追加されました。

• installments（分割回数）：支払いの総回数
• installment_index（今回の支払い回数）：何回目の支払いかを表します

プラン情報オブジェクト（plan）

{
  "payment_type": "決済タイプ（1: 1回払い, 4: 定期払い, 5: 毎月払い[回数制限付き]）",
  "name": "プラン名"
}

Discord連携情報オブジェクト（discord）

{
  "discord_id": "DiscordユーザーID",
  "discord_name": "Discordユーザー名（任意）"
}

LINE連携情報オブジェクト（line）

{
  "line_id": "LINEユーザーID",
  "line_name": "LINEユーザー名（任意）"
}

お届け先情報オブジェクト（shipping）

{
  "name": "お届け先の名前（任意）",
  "address_country": "国（任意）",
  "address_zip": "郵便番号（任意）",
  "address_state": "都道府県（任意）",
  "address_city": "市町村（任意）",
  "address_line1": "住所1（任意）",
  "address_line2": "住所2（任意）"
}

備考欄オブジェクト（remarks）

[
  {
    "name": "備考欄の項目名（任意）",
    "value": "顧客が入力した値（任意）"
  }
]

UTMパラメータオブジェクト（utm）

[
  {
    "name": "UTMパラメータ名（任意）",
    "value": "UTMパラメータ値（任意）"
  }
]

Webhookイベントのサンプル

以下は「決済成功(payment)」イベントのWebhook通知例です。

{
  "id": "a66fb8867f80ef7b9097fae64bcdd512",
  "event": "payment",
  "mode": "live",
  "create_at": "2025-01-23T10:34:19Z",
  "customer": {
    "customer_id": "3a7f0e8197955aa4178902e17371f1b5",
    "email": "taro@apps.com",
    "name": "アップス太郎",
    "company": "テスト会社",
    "phone_number": "+818018821111"
  },
  "payment": {
    "platform_id": 4,
    "price": 6680.0,
    "card": {
      "brand": "visa",
      "exp_month": 12,
      "exp_year": 2034,
      "last4": "0000"
    }
  },
  "plan": {
    "payment_type": 4,
    "name": "アップス月額プラン"
  }
}

関連情報

• Webhookの基本的な設定方法については Webhookの設定方法 をご覧ください。
• APIレスポンスデータの詳細は APIレスポンスデータ構造 を参照してください。