Skip to main content
POST
Create Webhook
註冊新的 Webhook 端點,透過 HTTP POST 接收即時事件通知。

請求內容

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.