完整說明見 Webhooks。
GET/api/WebhookDelivery— 列出投遞紀錄,可用 eventId 篩選
| 屬性 | 值 |
|---|
| 所需權限 | webhooks:read |
| Idempotency-Key | 不需要 |
| 參數 | 位置 | 型別 | 必填 |
|---|
page | query | integer (int32) | |
pageSize | query | integer (int32) | |
orderBy | query | string | |
orderDirection | query | string | |
createdFrom | query | string (date-time) | |
createdTo | query | string (date-time) | |
eventId | query | string | |
POST/api/WebhookDelivery/{webhookDeliveryId}/Retry— 自行重送一次投遞(需要 Idempotency-Key)
| 屬性 | 值 |
|---|
| 所需權限 | webhooks:write |
| Idempotency-Key | 必填 |
| 參數 | 位置 | 型別 | 必填 |
|---|
webhookDeliveryId | path | string | 必填 |
GET/api/WebhookEndpoint— 列出 Webhook endpoint
| 屬性 | 值 |
|---|
| 所需權限 | webhooks:read |
| Idempotency-Key | 不需要 |
| 參數 | 位置 | 型別 | 必填 |
|---|
page | query | integer (int32) | |
pageSize | query | integer (int32) | |
orderBy | query | string | |
orderDirection | query | string | |
createdFrom | query | string (date-time) | |
createdTo | query | string (date-time) | |
POST/api/WebhookEndpoint— 註冊一個新的 Webhook endpoint(signing secret 只顯示一次)
| 屬性 | 值 |
|---|
| 所需權限 | webhooks:write |
| Idempotency-Key | 不需要 |
| 參數 | 位置 | 型別 | 必填 |
|---|
description | body | string | |
events | body | array | |
url | body | string (uri) | |
GET/api/WebhookEndpoint/{webhookEndpointId}— 讀取單一 Webhook endpoint
| 屬性 | 值 |
|---|
| 所需權限 | webhooks:read |
| Idempotency-Key | 不需要 |
| 參數 | 位置 | 型別 | 必填 |
|---|
webhookEndpointId | path | string | 必填 |
PUT/api/WebhookEndpoint/{webhookEndpointId}— 更新 Webhook endpoint(網址、事件、啟用/停用)
| 屬性 | 值 |
|---|
| 所需權限 | webhooks:write |
| Idempotency-Key | 不需要 |
| 參數 | 位置 | 型別 | 必填 |
|---|
webhookEndpointId | path | string | 必填 |
description | body | string | |
events | body | array | |
status | body | string | |
url | body | string (uri) | |
GET/api/WebhookEvent— 列出已發生的 Webhook 事件
| 屬性 | 值 |
|---|
| 所需權限 | webhooks:read |
| Idempotency-Key | 不需要 |
| 參數 | 位置 | 型別 | 必填 |
|---|
page | query | integer (int32) | |
pageSize | query | integer (int32) | |
orderBy | query | string | |
orderDirection | query | string | |
createdFrom | query | string (date-time) | |
createdTo | query | string (date-time) | |
GET/api/WebhookEvent/{webhookEventId}— 取得單筆Webhook 事件。
| 屬性 | 值 |
|---|
| 所需權限 | webhooks:read |
| Idempotency-Key | 不需要 |
| 參數 | 位置 | 型別 | 必填 |
|---|
webhookEventId | path | string | 必填 |