Create Webhook

acuity_scheduling.create_webhook
ActionBusiness appsconnection required

Calls the Acuity Scheduling API with the connection's credentials.

Subscribe a URL to an Acuity appointment event so a workflow trigger receives it. An account may hold at most 25 subscriptions.

Connection

Required
Yes — the node will not save without one
Auth type
Username & password
Providers
Acuity Scheduling
Secret shape
{"user_id": "123456", "api_key": "…"}
Config it needs
calendar_id
Resolved by
config.connection_id, else node.connection_id

Configuration

2 fields, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.

FieldTypeRequiredDefaultConstraintsExample
event
The appointment event Acuity should deliver to the target URL.
stringNoappointment.scheduledone of "appointment.scheduled", "appointment.rescheduled", "appointment.canceled", "appointment.changed", "order.completed"—
target
HTTPS URL Acuity posts the event to; use this workflow's webhook trigger URL.
stringYes—url formathttps://hooks.example.com/acuity

Example configuration

Every value below is the contract’s own example or default — nothing invented.

{
  "event": "appointment.scheduled",
  "target": "https://hooks.example.com/acuity"
}

Output

One shape.

result

FieldTypeExample
id
Numeric id of the webhook subscription.
number—
event
The event this subscription delivers.
string—
target
The URL Acuity posts the event to.
string—
status
Delivery status Acuity reports for the subscription.
string—
{
  "event": "",
  "id": 0,
  "status": "",
  "target": ""
}

See Create Webhook run in a workflow.

In a technical demo we add the Acuity Scheduling connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.