v1

latestOpenAPI 3.1.02026-07-26364986.4 KB

Webhooks

Retrieve a webhook subscription

Returns the details of a single webhook subscription by ID.

get/api/2026-01-01/webhooks/{webhook_id}

webhook_idstring uuid required

The ID of the webhook subscription

The webhook subscription

idstring uuid required

Unique identifier for the webhook subscription

event_topic'APPOINTMENT_BOOKED' | 'APPOINTMENT_CANCELLED' | 'APPOINTMENT_UNCANCELLED' | 'APPOINTMENT_RESCHEDULED' required

The event topic this subscription receives

target_urlstring required

The HTTPS URL that receives webhook event payloads

clinic_guidinteger required

The clinic identifier this subscription belongs to

status'active' | 'inactive' required

Whether the subscription is currently active

updated_atstring date-time required

When the subscription was last updated

created_atstring date-time required

When the subscription was created