外部連携

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} โปรดดูวิธีขอ token ได้ที่คู่มือการยืนยันตัวตน

ดู API การยืนยันตัวตนและการเข้าถึง
ไปที่เอกสารอ้างอิง API