In order to receive data from the PainChek system, a webhook must be configured to subscribe to a specific event. Once an event subscription has been set up; all configured URLs will receive an automated HTTP POST payload containing the event information, as well as the data payload which would be expected if the client had directly called the API.
Each event corresponds to a specific action that can be performed on the PainChek API. As all of our applications (including our web portal) use the API, subscribing to API events is the most granular and effective way of ensuring you get the data exactly how our systems would.
The client may subscribe to the following events:
|Events||Description||Introduced in Webhook Version||Expected Release Date||API|
Whenever an assessment is submitted to the PainChek API - the assessment_add webhook event will be triggered.
The API column links to the API call that returns data in the same (or very similar) format to the webhook. You can use it as a resource to understand the contents of the payload included with the call to the webhook URL.