Skip to main content
POST
Create Webhook
HTTP POST でリアルタイムのイベント通知を受信するための新しい Webhook エンドポイントを登録します。

リクエストボディ

string
必須
Webhook イベントを受信する HTTPS URL。
string[]
必須
サブスクライブするイベントタイプのリスト。利用可能なイベントタイプについては、Webhooks をご参照ください。
string
必須
Webhook ペイロードを検証するための署名シークレット。whsec_ で始まる必要があります。

Response

承認

X-API-Key
string
header
必須

API key authentication. Keys are prefixed with awx_.

ボディ

application/json
url
string<uri>
必須

The HTTPS URL that will receive webhook events.

events
string[]
必須

List of event types to subscribe to (e.g., payment.completed, payment.failed, policy.violated).

secret
string
必須

Signing secret used to verify webhook payloads. Must start with whsec_.

レスポンス

Webhook created successfully.

A registered webhook endpoint for receiving real-time event notifications.

id
string

Unique webhook identifier (e.g., whk_abc123).

url
string<uri>

HTTPS URL that receives webhook events.

events
string[]

List of subscribed event types.

status
enum<string>

Webhook status.

利用可能なオプション:
active,
inactive
created_at
string<date-time>

ISO 8601 creation timestamp.