Webhookの設定方法（Apps API）

Apps APIでは、各種イベント（申し込み完了・決済成功など）が発生したときにWebhookによって通知を受け取ることができます。

Webhookとは？

Webhookは、Appsで特定のイベントが発生した際に、指定したURLに対してイベント情報を自動的に通知する仕組みです。
例えば、申し込み完了時や決済成功時にリアルタイムで顧客管理システムやチャットツールに通知できます。

Webhookの設定手順

Webhookを利用するには以下の手順で設定します。

• 管理画面にログインし、「API設定 → Webhook設定」へアクセスします。
• 「エンドポイントURL」に通知を受け取りたいURLを入力します。
• 通知を受け取りたいイベントにチェックを入れ、「更新」ボタンをクリックして設定を保存します。

テスト送信で疎通確認する

設定したエンドポイントに、選択したイベントのダミーJSONを即時POSTして疎通確認できます。実データ作成や課金は発生しません。

• 「エンドポイントURL」を入力して保存（更新）します。
• 受信したいイベントにチェックを入れます。
• 右側の「テスト送信」ボタンをクリックするとダイアログが開きます。

テスト送信ダイアログの使い方

• 「イベント」：テストしたいイベントを選択（全イベント対応）。
• 「ペイロード」：選択イベントのダミーJSONが自動表示（本番と同一構造、値はダミー）。
• 「送信」：エンドポイントURLへHTTP POSTを実行。
• 「応答」：HTTPステータス／応答時間／応答サイズを表示（例：HTTP 200 / 849 msec / 48394 B）。
• 成功条件：30秒以内に HTTP 200 OK（本番通知と同じ要件）。
• 結果は「Webhook履歴」で確認・再送できます。

設定可能なイベント一覧

Webhook通知の仕様

• イベント通知はHTTP POSTメソッドでJSON形式のデータが送信されます。
• 通知を受け取るエンドポイントは、30秒以内にHTTPステータスコード「200 OK」を返す必要があります。
• 30秒以上応答がない場合やエラー（200 OK以外）が返ってきた場合、3回まで自動再送が試行されます。
• 再送に3回失敗すると通知エラー扱いとなります。

※「テスト送信」も本番通知と同一の応答要件（30秒以内に 200 OK）・同一データ構造（値はダミー）が適用されます。

Webhook通知のサンプルデータ

以下は「顧客の新規作成」イベントの通知例です。

{
  "id": "58886defd811bdbadec04bafd19d9f58",
  "event": "customer",
  "mode": "live",
  "create_at": "2025-02-01T10:07:31Z",
  "customer": {
    "customer_id": "3a7f0e8f97955aa4178902e17371f1b5",
    "email": "taro@apps.com",
    "name": "アップス太郎",
    "company": "テスト会社",
    "phone_number": "+818018821111"
  }
}

※「テスト送信」のダミーペイロードは、本セクションのサンプルJSONと同一構造です（値のみダミー）。

各イベントの詳細なデータ構造

Webhookで通知されるデータの詳細な構造については、以下のページをご覧ください。

• Webhookデータ構造

注意点・よくある質問

• 複数のイベントを同時に受信することも可能です。その場合、受け取り側でイベントの種類を識別して処理してください。
• 本番環境で通知エラーが続いた場合、Webhook履歴画面から手動で再送することができます。