webhooks

A new appointment has been created

postWebhookappointment.created

Payload

typestring

The event type

Example payload

{
  "type": "appointment.created",
  "data": {
    "eventId": "182c2e54-3494-4b85-aba5-038cf539d5bf",
    "patientId": "9a5e64b0-0a73-4cb5-ab32-44fea16da4e1",
    "userId": "3c1e2f6a-9b7d-4a2e-8f3c-1d5e6a7b8c9d",
    "startTime": "2024-01-01T00:00:00Z",
    "endTime": "2024-01-01T01:00:00Z",
    "status": "active"
  }
}

Response

200 status indicates that the data was received successfully

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.