Webhook behaviour
This service delivers webhook callbacks to external endpoints. NOTE: The callbacks serve as state-change notifications and are intended to be used alongside our API, rather than providing data directly
Handling callbacks
Callbacks are delivered to the configured callback_url in your subscription via a POST request
Each request includes a Basic authorisation header. This is the Base64 encoded value of the :
A subscription with webhookName "test" and password "pass1234" will therefore yield an auth header of "Basic dGVzdDpwYXNzMTIzNA=="
Handlers must acknowledge each callback within 15s with a 2xx response, or it will be re-sent.
Retries
Failed deliveries are retried after 30 seconds, then after 60s, 120s etc, with the backoff duration doubling after each attempt
A maximum of 14 deliveries will be attempted after which no further attempts will be made
Ordering & Idempotency
Receivers should be idempotent, as strict ordering cannot be guaranteed and duplicate deliveries are possible (e.g. after timeouts or transient errors).