跳轉到主要內容
PUT
/
api
/
v1
/
webhooks
/
{id}
Update Webhook
curl --request PUT \
  --url https://api.agentwallex.com/api/v1/webhooks/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "events": [
    "payment.completed",
    "payment.failed",
    "policy.violated",
    "agent.frozen"
  ]
}
'
{
  "id": "<string>",
  "url": "<string>",
  "events": [
    "<string>"
  ],
  "created_at": "2023-11-07T05:31:56Z"
}

​
路徑參數

​
id
string
必填
要更新的 Webhook ID（例如 whk_abc123）。

​
請求內容

​
url
string
更新後的 Webhook 端點 HTTPS URL。
​
events
string[]
更新後的事件類型訂閱清單。
​
secret
string
更新後的簽名金鑰。必須以 whsec_ 開頭。

​
範例

curl -X PUT https://api.agentwallex.com/api/v1/webhooks/whk_abc123 \
  -H "X-API-Key: awx_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "events": ["payment.completed", "payment.failed", "policy.violated", "agent.frozen"]
  }'

授權

​
X-API-Key
string
header
必填

API key authentication. Keys are prefixed with awx_.

路徑參數

​
id
string
必填

The webhook ID to update (e.g., whk_abc123).

主體

application/json
​
url
string<uri>

Updated HTTPS URL for the webhook endpoint.

​
events
string[]

Updated list of event types to subscribe to.

​
secret
string

Updated signing secret. Must start with whsec_.

回應

Webhook updated 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.