外部連携
Webhook通知API
購買・広告・在庫更新などのイベント発生時に、指定したURLへリアルタイムで通知します。Webhookエンドポイントの登録・管理・テストに対応しています。
api/v1/webhooks
APIリファレンスで確認
エンドポイント一覧
| メソッド | パス | 説明 | レスポンス |
|---|---|---|---|
| GET |
/api/v1/webhooks/
|
登録済みWebhook一覧
登録されたWebhookエンドポイントとイベントサブスクリプション、ステータスの一覧を返します。
|
200 |
| GET |
/api/v1/webhooks/{id}
|
Webhook詳細を取得
単一のWebhookエンドポイントの完全な設定を返します。
|
200 404 |
| POST |
/api/v1/webhooks/
|
新規Webhookを登録
特定のイベントタイプ用に新しいWebhookエンドポイントを登録します。
|
200 400 |
| POST |
/api/v1/webhooks/test/{id}
|
テストWebhookを送信
テストイベントペイロードを送信して、Webhookエンドポイントの到達性を検証します。
|
200 404 |
| DELETE |
/api/v1/webhooks/{id}
|
Webhookを削除
Webhookエンドポイントを削除します。
|
204 404 |
エンドポイント詳細
登録されたWebhookエンドポイントとイベントサブスクリプション、ステータスの一覧を返します。
完全パス：
GET /api/v1/webhooks/
レスポンスコード：
200
単一のWebhookエンドポイントの完全な設定を返します。
完全パス：
GET /api/v1/webhooks/{id}
レスポンスコード：
200
404
特定のイベントタイプ用に新しいWebhookエンドポイントを登録します。
完全パス：
POST /api/v1/webhooks/
レスポンスコード：
200
400
テストイベントペイロードを送信して、Webhookエンドポイントの到達性を検証します。
完全パス：
POST /api/v1/webhooks/test/{id}
レスポンスコード：
200
404
Webhookエンドポイントを削除します。
完全パス：
DELETE /api/v1/webhooks/{id}
レスポンスコード：
204
404
リクエスト例
リクエスト
POST /api/v1/webhooks
Authorization: Bearer {access_token}
{
"url": "https://your-app.com/webhooks",
"events": ["purchase.completed", "order.shipped"],
"secret": "your-webhook-secret"
}
レスポンス
{
"id": "wh-001",
"url": "https://your-app.com/webhooks",
"events": ["purchase.completed", "order.shipped"],
"status": "active",
"createdAt": "2025-03-20T10:00:00Z"
}
認証について
このAPIを利用するには、Authorization: Bearer {access_token} ヘッダーが必要です。
トークンの取得方法は認証ガイドをご確認ください。