Skip to main content
Automation rules run actions when a booking event fires. See the API reference for the full resource shape.

​
List automation rules

neetocal automation-rules list
neetocal automation-rules list --page 1 --page-size 20
FlagTypeRequiredDefaultDescription
--pageint0Page number
--page-sizeint0Items per page (max 100)
Sample output (--json)
{
  "data": [
    {
      "id": "efb296a3-8205-419f-8ac4-1abfc46bc3c7",
      "name": "Notify on confirm",
      "meeting_ids": ["mtg_abc"]
    }
  ],
  "pagination": { "total_records": 1, "total_pages": 1, "current_page_number": 1, "page_size": 30 }
}
Mirrors List automation rules in the API.

​
Create an automation rule

neetocal automation-rules create \
  --event booking_confirmed \
  --name "Notify on confirm" \
  --json-file actions.json
FlagTypeRequiredDefaultDescription
--eventstringYesTrigger event
--json-filestringPath to JSON file with meeting_ids and actions
--namestringRule name
The --json-file holds the meetings the rule applies to and the actions to run:
actions.json
{
  "meeting_ids": ["mtg_abc", "mtg_def"],
  "actions": [
    { "type": "send_email", "template_id": "tmpl_123" },
    { "type": "add_to_calendar" }
  ]
}
Sample output (--json)
{
  "data": {
    "workflow": {
      "id": "efb296a3-8205-419f-8ac4-1abfc46bc3c7",
      "name": "Notify on confirm",
      "meeting_ids": ["mtg_abc", "mtg_def"]
    }
  }
}
Mirrors Create automation rule in the API.

​
Delete an automation rule

neetocal automation-rules delete <id>
Removes the rule with the given id. In --quiet mode this prints success.
Sample output
Automation rule deleted successfully.
Mirrors Delete automation rule in the API.