Webhooks notify external systems about events happening in the care flow in real-time. Awell orchestration transmits such an event when:
A care flow is started or completed
An activity is created or completed, including system activities
A data point collected or
A form is submitted or
A reminder created or
A hosted session is started, expired or completed. Here you can find more information on hosted care flow and hosted activity.
You can subscribe to these events via webhooks and consequently, trigger a suitable action in your system based on these events.
How to create and configure a webhook
In the care flow settings page under webhooks you click on create webhook
Fill in all necessary details:
Name for the webhook
Test endpoint url to which we send a HTTP POST request for every event during preview
Endpoint url to which we send a HTTP POST request for every event during orchestration
Headers allows you to add custom key-value pairs which will be added as headers in all requests, for additional security measures.
Subscriptions to select the events this specific webhook should deliver
Click create to create the webhook
Get webhook signature
Once you created a webhook, you can retrieve it's signature or public key at the bottom of the webhook settings page:
Enable/disable webhooks
The toggle on the webhooks page allows you to enable or disable your webhook, without the need do delete it.
Testing and monitoring webhooks
Once you set up your webhook, check this article to test your webhook in preview mode, or read up on how webhooks work in orchestration, when actually running live activities in a production setting.