v1

latestOpenAPI 3.1.02026-07-26364986.4 KB

Webhooks

Register a webhook subscription

Registers a new webhook subscription for the authenticated partner. The signing secret is returned only in this response and cannot be retrieved again — store it securely. The secret is used to verify that webhook payloads are sent by Jane.

post/api/2026-01-01/webhooks

Request body

event_topicstring required

The event topic to subscribe to

target_urlstring required

The HTTPS URL that will receive webhook event payloads

Response

The webhook subscription was registered

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

secretstring

HMAC signing secret for verifying webhook payload authenticity. Present only on initial registration.