Webhooks
How Awell care flows send webhook calls to your systems, and how to inspect and retry them.
A care flow can call out to your systems as it runs, for example to notify you when an activity completes. Awell records each of these as a webhook call you can inspect and retry through the API.
Inspecting and retrying webhook calls
The API exposes webhook calls as data you can query and act on:
- Query them with
webhookCall,webhookCalls, and related operations. See API calls & webhooks. - Retry failed deliveries with
retryWebhookCalland the bulkretryAll…mutations. - Subscribe to
webhookCallCreatedandwebhookCallUpdatedfor real-time updates. See Subscriptions.
Receiving and verifying webhooks
Configuring, receiving and verifying are covered in full elsewhere on this site rather than repeated here — this page is about the webhook calls the API exposes as data.
| To do this | Go to |
|---|---|
| Build the endpoint, verify the signature, handle repeats | Receive webhook events |
| See what each event reports, and what it does not | Webhook event catalog |
| See the shape of what arrives | Webhook payloads |
| Turn webhooks on for one care flow | Configure webhooks in Studio |
| Turn them on for every published care flow at once | Configure webhooks for all care flows |
Before you build the receiving end: payloads carry identifiers, not clinical detail, so you fetch what you need through the API using them. Delivery also repeats and can arrive out of order, so the endpoint has to be idempotent.
Related
E.164 phone numbers
The Awell Orchestration API accepts phone numbers only in E.164 format: the validation rules applied, what they do and don't prove, and how to convert numbers stored another way.
Domain model
The objects the Orchestration API works with, and the lifecycle of a typical integration from creating a patient to submitting a form.