Authorization
Use a server-side API key with the listed grants and permitted resource access.
webhooks:manageRequest headers
X-Api-Keyrequired- Your server-side integration credential.
If-Matchrequired- Current ETag for the resource being changed. A stale version returns 412.
Path parameters
idstring · required- Opaque identifier in the authorized resource scope. Nested identifiers must belong to their parent resource.
Response
200OK
Returns the authorized resource or result for this operation. List results use items, nextCursor, and hasMore.
Behavior to account for
Events are delivered at least once. Deduplicate by event ID, compare resource versions, and retain a replay cursor.
Errors
Authentication failures return 401 or 403. Inaccessible resources return 404. Business and idempotency conflicts return 409. Rate limits return 429 with retry guidance.
Error handling guide