​
Subscriptions

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.

​
Output Shape

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:

{
  "type":"shift",
  "updated_at":"2023-02-01T08:00:00-04:00",
  "triggering_location":"DASHBOARD",
  "shift": {
	  "shift_id": "123e4567-e89b-12d3-a456-426614174000",
	  "is_canceled": true,
	  "clinician_id": "987e6543-e21a-45b3-c567-789101112131",
	  "territory_ids": [
	    "abcd1234-5678-90ef-ghij-1234567890kl",
	    "mnop1234-5678-90ef-qrst-1234567890uv"
	  ],
	  "clinic_id": "abcd4321-5678-90ef-ghij-1234567890kl",
	  "time_zone": "America/New_York",
	  "start_datetime": "2023-05-01T08:00:00-04:00",
	  "end_datetime": "2023-05-01T16:00:00-04:00",
	  "notes": "Shift coverage for Dr. Smith",
	  "rrule": "FREQ=WEEKLY;BYDAY=MO,WE,FR",
	  "exdates": [
	    "2023-05-08T08:00:00-04:00",
	    "2023-05-15T08:00:00-04:00"
	  ]
	}
}

​
Sequencing

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.

​
Security

To verify the webhooks you receive were sent by Axle Health and not by an unauthorized third-party, you can follow the guide here:

Webhook Signatures