Axle currently sends webhooks for the following resources:
To manage webhook subscriptions, contact us at techsupport@axlehealth.com.
If you want, you can provide multiple URLs. Each URL will get all the webhook events.
If your webhook endpoint returns a non-successful status code, we will retry up to 3 times.
All webhooks will include the following fields:
type
: "visit" | "shift"
updated_at
: datetime
triggering_location
: "PATIENT_PORTAL" | "CLINICIAN_APP" | "DASHBOARD" | "API" | "AXLE_SYSTEM"
In addition to the above fields, exactly one of the following fields will be present depending on the type of the resource above:
For example, the shift webhook looks as follows:
If an object is edited multiple times, a webhook will be sent for each edit. The webhook will include the state of the resource as it was exactly after the edit.
The updated_at
field is the time that the webhook was enqueued to be sent in our system. It may not be the time your system receives the webhook.
Advanced:
To avoid processing outdated data, you can collect webhooks into a queue. You can then filter for webhooks at least 5 minutes old, sort by updated_at
, and pull the earliest events off the top. Alternatively, you can remember the last updated_at
time you processed for a given resource, and ignore webhooks sent for it earlier than that.
To verify the webhooks you receive were sent by Axle Health and not by an unauthorized third-party, you can follow the guide here:
Axle currently sends webhooks for the following resources:
To manage webhook subscriptions, contact us at techsupport@axlehealth.com.
If you want, you can provide multiple URLs. Each URL will get all the webhook events.
If your webhook endpoint returns a non-successful status code, we will retry up to 3 times.
All webhooks will include the following fields:
type
: "visit" | "shift"
updated_at
: datetime
triggering_location
: "PATIENT_PORTAL" | "CLINICIAN_APP" | "DASHBOARD" | "API" | "AXLE_SYSTEM"
In addition to the above fields, exactly one of the following fields will be present depending on the type of the resource above:
For example, the shift webhook looks as follows:
If an object is edited multiple times, a webhook will be sent for each edit. The webhook will include the state of the resource as it was exactly after the edit.
The updated_at
field is the time that the webhook was enqueued to be sent in our system. It may not be the time your system receives the webhook.
Advanced:
To avoid processing outdated data, you can collect webhooks into a queue. You can then filter for webhooks at least 5 minutes old, sort by updated_at
, and pull the earliest events off the top. Alternatively, you can remember the last updated_at
time you processed for a given resource, and ignore webhooks sent for it earlier than that.
To verify the webhooks you receive were sent by Axle Health and not by an unauthorized third-party, you can follow the guide here: