Webhooks let your integration receive real-time notifications as events happen
across callouts, responders, customers, and subscriptions — instead of
polling. You register an endpoint URL and the events you care about, and AURA
sends a POST with the event payload whenever one occurs.
POST requests.message field naming the event, plus the relevant entity
(callout, customer, or subscription).Subscribe to any combination of the events below.
Each delivery is a JSON object keyed by message (the event name) plus the
entity it concerns. For example, a callout event:
Responder-related callout events additionally carry an incidentInformation
block with dispatch details (responder, supplier, response type, classification,
and timestamps for dispatch / arrival / completion).
You can manage your webhook two ways:
The endpoint URL must be HTTPS. Each customer source has a single active webhook, so registering again replaces the previous configuration.
Custom headers — any headers you register (e.g. an Authorization token)
are included on every delivery, so your endpoint can authenticate the caller.
IP allowlisting — webhook requests are sent from fixed AURA IP addresses. Allowlist them if your endpoint restricts inbound traffic:
2xx and process asynchronously.message + the entity id to deduplicate and route.Point a webhook at a mock endpoint (for example webhook.site) during development, then trigger events through the API — create a customer, raise a callout, activate a subscription — and confirm the payloads arrive. Switch to your real endpoint once verified.