Webhooks

Full guide at Webhooks.

GET/api/WebhookDelivery— List delivery attempts, optionally filtered by eventId

Property	Value
Required scope	`webhooks:read`
Idempotency-Key	Not required

Parameter	In	Type
`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— Self-serve retry a delivery (requires Idempotency-Key)

Property	Value
Required scope	`webhooks:write`
Idempotency-Key	Required

Parameter	In	Type	Required
`webhookDeliveryId`	path	string	Required

GET/api/WebhookEndpoint— List webhook endpoints

Property	Value
Required scope	`webhooks:read`
Idempotency-Key	Not required

Parameter	In	Type
`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— Register a new webhook endpoint (signing secret shown once)

Property	Value
Required scope	`webhooks:write`
Idempotency-Key	Not required

Parameter	In	Type
`description`	body	string
`events`	body	array
`url`	body	string (uri)

GET/api/WebhookEndpoint/{webhookEndpointId}— Retrieve a single webhook endpoint

Property	Value
Required scope	`webhooks:read`
Idempotency-Key	Not required

Parameter	In	Type	Required
`webhookEndpointId`	path	string	Required

PUT/api/WebhookEndpoint/{webhookEndpointId}— Update a webhook endpoint (URL, events, enable/disable)

Property	Value
Required scope	`webhooks:write`
Idempotency-Key	Not required

Parameter	In	Type	Required
`webhookEndpointId`	path	string	Required
`description`	body	string
`events`	body	array
`status`	body	string
`url`	body	string (uri)

GET/api/WebhookEvent— List webhook events that occurred

Property	Value
Required scope	`webhooks:read`
Idempotency-Key	Not required

Parameter	In	Type
`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 事件。

Property	Value
Required scope	`webhooks:read`
Idempotency-Key	Not required

Parameter	In	Type	Required
`webhookEventId`	path	string	Required