Dynamic Webhooks
Acuity's Webhooks API supports creating new webhook subscriptions dynamically. Each subscription consists of an event
name, and a target
URL, which must be on port 443 or 80. Events supported include:
appointment.scheduled
appointment.rescheduled
appointment.canceled
appointment.changed
order.completed
Once a subscription is created, we'll notify your server with the appointment ID when the event occurs. Retrieve the full appointment details using our get-appointments API. Existing webhooks can be listed and deleted. Delete a webhook, and we'll leave you alone!
Endpoints:
- post/webhooks to create a new webhook.
- get/webhooks to list all active webhooks.
- get/webhooks/:id to delete a webhook subscription, ending notifications.
/webhooks
Webhooks Limit
A maximum of 25 webhooks can be created per Acuity account. A 400 error will be returned when that limit is reached.
POST https://acuityscheduling.com/api/v1/webhooks
>>>
{
"event": "appointment.scheduled",
"target": "https://127.0.0.1/test-create"
}
<<<
{
"id": 1,
"event": "appointment.scheduled",
"target": "https://127.0.0.1/test-create",
"status": "active"
}
/webhooks
GET https://acuityscheduling.com/api/v1/webhooks
/webhooks/:id
DELETE https://acuityscheduling.com/api/v1/webhooks/:id