Webhooks

Awell uses webhooks to notify your application when an event happens in a pathway. Webhooks are particularly useful for asynchronous events such as when a stakeholder completes an action or a pathway gets completed.

How Awell uses webhooks

A webhook enables Awell to push real-time notifications to your app. Awell uses HTTPS to send these notifications to your app as a JSON payload. You can then use these notifications to execute actions in your backend systems. To learn more, see the webhook events overview.

Steps to receive webhooks

You can start receiving event notifications in your app using the steps in this section:

1. Identify the events you want to monitor and the event payloads to parse.
2. Create a webhook endpoint as an HTTPS endpoint (URL) that can accept POST requests on your local server.
3. Handle requests from Awell by parsing each event object and returning 2xx response status codes.
4. Deploy your webhook endpoint so it’s a publicly accessible HTTPS URL.
5. Register your publicly accessible HTTPS URL in the Pathway settings of a pathway in Awell studio.

Configure webhooks in pathways

Webhooks are configured on a per pathway basis in Awell Studio (see Settings > Webhooks). You can find more information on how to configure webhooks in your care flows/pathways here.

Webhooks can be configured separately for pathway preview (when building and testing pathways) and for pathway orchestration. In addition, when previewing care flows/pathways all webhooks are skipped by default but you have the ability to trigger them manually to test your endpoint implementation.