Listening to Webhooks

You can choose to be notified via webhook when clinical artifacts (transcript, summary, and progress note) are generated. When you have configured webhooks for your partner organization by providing a callbackUrl, you will receive a POST call to the endpoint you have provided. This call will include the following:

Headers

• Content-Type: application/json

• X-API-Key: your-api-key

• X-Blueprint-Signature: HMAC hash of the body of the request, using the clientSecret of the partner organization

To calculate and verify X-Blueprint-Signature you create SHA-256 hash of the body using your API key and then take the digest. For example:

const hmac = crypto.createHmac('sha256', your-client-secret);
hmac.update(request-body);
const signature = hmac.digest('hex');

Body

The body of the request in a webhook callback will include identifiers you can use to get additional details via API. See the webhook API reference for the list of events and a description of the payloads for each event type.

Retries

In the instance the callback fails with a non 200 status, the event will be retried every 5 minutes giving your event multiple opportunities to succeed during temporary service disruptions or intermittent issues.