Webhooks

註冊 endpoint、查事件與投遞紀錄。

檢視 Markdown

完整說明見 Webhooks。

GET/api/WebhookDelivery— 列出投遞紀錄,可用 eventId 篩選
屬性值
所需權限webhooks:read
Idempotency-Key不需要
參數位置型別必填
pagequeryinteger (int32)
pageSizequeryinteger (int32)
orderByquerystring
orderDirectionquerystring
createdFromquerystring (date-time)
createdToquerystring (date-time)
eventIdquerystring
POST/api/WebhookDelivery/{webhookDeliveryId}/Retry— 自行重送一次投遞(需要 Idempotency-Key)
屬性值
所需權限webhooks:write
Idempotency-Key必填
參數位置型別必填
webhookDeliveryIdpathstring必填
GET/api/WebhookEndpoint— 列出 Webhook endpoint
屬性值
所需權限webhooks:read
Idempotency-Key不需要
參數位置型別必填
pagequeryinteger (int32)
pageSizequeryinteger (int32)
orderByquerystring
orderDirectionquerystring
createdFromquerystring (date-time)
createdToquerystring (date-time)
POST/api/WebhookEndpoint— 註冊一個新的 Webhook endpoint(signing secret 只顯示一次)
屬性值
所需權限webhooks:write
Idempotency-Key不需要
參數位置型別必填
descriptionbodystring
eventsbodyarray
urlbodystring (uri)
GET/api/WebhookEndpoint/{webhookEndpointId}— 讀取單一 Webhook endpoint
屬性值
所需權限webhooks:read
Idempotency-Key不需要
參數位置型別必填
webhookEndpointIdpathstring必填
PUT/api/WebhookEndpoint/{webhookEndpointId}— 更新 Webhook endpoint(網址、事件、啟用/停用)
屬性值
所需權限webhooks:write
Idempotency-Key不需要
參數位置型別必填
webhookEndpointIdpathstring必填
descriptionbodystring
eventsbodyarray
statusbodystring
urlbodystring (uri)
GET/api/WebhookEvent— 列出已發生的 Webhook 事件
屬性值
所需權限webhooks:read
Idempotency-Key不需要
參數位置型別必填
pagequeryinteger (int32)
pageSizequeryinteger (int32)
orderByquerystring
orderDirectionquerystring
createdFromquerystring (date-time)
createdToquerystring (date-time)
GET/api/WebhookEvent/{webhookEventId}— 取得單筆Webhook 事件。
屬性值
所需權限webhooks:read
Idempotency-Key不需要
參數位置型別必填
webhookEventIdpathstring必填