Outbound event delivery
Wicket POSTs a delivery to each subscribed endpoint when events match that endpoint's filters. Events that occur close together are batched into one delivery.
Event types follow <resource>.<action>, for example
people.changed, people.email_changed, people.deleted,
organizations.changed, roles.granted, connections.deleted.
A one-off verification ping (test: true, empty events) is sent
when an endpoint is created or its target URL changes.
Delivery semantics
- Timeout: Wicket waits up to 20 seconds for a response. Slower responses are treated as failures.
- Success: any
2XXstatus. Response body is ignored. - Retry: any non-
2XXresponse, connection failure, or timeout triggers a retry with exponential backoff over several days. The samewebhook_bundle_uuidis redelivered on each attempt. - Idempotency: receivers must dedupe on
webhook_bundle_uuid, since retries (and rare double-deliveries) can repeat the same bundle. - Ordering: deliveries are not strictly ordered. Use
event_timestampif you need to apply changes in causal order.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
Example Requests
/delivery/delivery/delivery/delivery/delivery