コンテンツにスキップ
AchaduDevelopers
Developers/API/webhook_create
Webhook

Webhook の作成

HTTPS 宛先を作成し、シークレットを 1 回公開します。

POST/webhookswebhooks:write
行動

変更は検証され、応答する前にキー アカウントに保存されます。返されたリソースを信頼できる情報源としてクエリします。

効果

リソースを変更し、対応するドメイン イベントを発行できます。

繰り返し

ネットワーク障害が発生した場合は、リソースの状態を確認してから再試行してください。バックオフとジッターを使用して 429 と 5xx のみを自動的にやり直します。

リクエスト

namestring · body目的地名。必須
urlstring · bodyパブリック HTTPS URL。uri必須
eventsarray · bodyイベントまたは*。必須
activeboolean · body宛先をアクティブにします。オプション
AuthorizationBearer ach_live_...
Acceptapplication/json
範囲webhooks:write

実行ファイルの例

curl
curl -X POST 'https://achadu.com/api/v1/webhooks' \
  -H 'Authorization: Bearer ach_live_...' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data '{
  "name": "My integration",
  "url": "https://example.com/product",
  "events": [
    "offer.created"
  ],
  "active": true
}'

応答とエラー

すべての応答には request_id が含まれます。リストにはページネーションが追加されます。可変リソースは、操作後に永続化された状態を返します。

201 application/json
{
  "data": {
    "id": "wh_01J...",
    "name": "Production",
    "url": "https://example.com/webhooks/achadu",
    "events": [
      "offer.created"
    ],
    "active": true,
    "created_at": "2026-08-31T18:20:00.000Z"
  },
  "created": true,
  "request_id": "req_01J..."
}
201Resource created and persisted.
400Invalid parameter, body or transition.
401キーが見つからない、無効、期限切れ、または取り消されています。
402アカウント プランでは、このインターフェイスはリリースされません。
403A chave precisa do escopo webhooks:write.
404このアカウントには機能が存在しません。
409The current state prevents this operation.
413The JSON body exceeds 128 KB.
4291 分あたり 120 リクエストのウィンドウを超えました。