Pre-release — content may change.

Webhooks

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 2XX status. Response body is ignored.
  • Retry: any non-2XX response, connection failure, or timeout triggers a retry with exponential backoff over several days. The same webhook_bundle_uuid is 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_timestamp if 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

POST/delivery

POST/delivery

POST/delivery

POST/delivery

POST/delivery