Webhooks allow you to be notified automatically when a Symptom Check or Illness Check has been completed and the report is available. This is particularly useful if you want to receive updates without polling our API.
Callback Payload
Once the check finishes, you’ll receive a POST request to your Webhook URL with:
-
checkId: the identifier to obtain the report
-
state: (optional) the value you passed in at check‑start for correlating with your internal records
Without state
{
"checkId": "2c6e3cea-8313-47e2-b84b-0ebf26e92252"
}
With state
{
"checkId": "2c6e3cea-8313-47e2-b84b-0ebf26e92252",
"state": "20354d7a-e4fe-47af-8ff6-187bca92f3f9"
}
Getting Started
-
Add the Webhook URL
In the Client Hub, select your API key and enter the webhook endpoint.
-
(Optional) Include state on check start
Send a state parameter when initiating a check to identify it later. For full details, see our Authentication guide.
-
Receive the callback
When processing finishes, you’ll get the payload shown above. Use checkId (and state if present) to match the report to your user or internal session.
-
Fetch the report
Retrieve the final report using our Chatbot Report endpoint.