Skip to main content
Automation rules run actions when a booking event occurs. For fields and response details, see the API reference.

List automation rules

This command shows automation rules in your workspace. Use this when you want to review configured triggers and actions.
Sample output (--json)

Create an automation rule

This command creates a new automation rule. Use this when you want to configure automated actions triggered by booking events.
  • The --json-file holds the meetings the rule applies to and the actions to run. meeting_ids are meeting UUIDs. Each action needs type, email_subject and email_body. The calendar actions (send_calendar_invite_to_anyone, or send_calendar_cancellation_to_anyone with --event booking_cancelled) also need emails, calendar_invite_subject, and calendar_invite_body:
rule.json
Sample output (--json)
  • To take the meeting off the invited calendars when it is cancelled, create a second rule with --event booking_cancelled and a send_calendar_cancellation_to_anyone action. Use the same emails and calendar_invite_subject as the invite rule. Any other event fails with a 422 error.
cancel-rule.json
  • To email the person who booked, use a send_email_to_client action. The optional client_types sends only to first_time clients (no earlier confirmed booking in the workspace), only to returning clients, or to both; leave it out to email everyone. Someone is returning when an earlier confirmed booking on any scheduling link shares their email or phone number.
welcome-rule.json

Delete an automation rule

This command deletes an automation rule. Use this when you no longer need a configured rule.
Required arguments:
  • <id> - Automation rule UUID
Removes the rule with the given id. In --quiet mode this prints success.
Sample output