WorkflowRule

A rule that triggers workflow actions based on events

actions object[]required

Actions to execute when this rule is triggered

Array [

created_atdate-timerequired

When the workflow action was created

idstringrequired

Unique workflow action identifier (opaque ID)

properties objectrequired

Action-specific configuration properties

property name*any

Action-specific configuration properties

typestringrequired

Type of action to execute

Possible values: [send_custom_email, trigger_automation]

]

created_atdate-timerequired

When the workflow rule was created

idstringrequired

Unique workflow rule identifier (opaque ID)

trigger_offset_amountintegerrequired

Amount of time offset for the trigger

trigger_offset_directionstringrequired

Direction of the trigger offset relative to the event

Possible values: [before, after]

trigger_offset_unitstringrequired

Unit of time for the trigger offset

Possible values: [minutes, hours, days]

trigger_typestringrequired

Type of event that triggers this rule

Possible values: [event_created, event_canceled, event_rescheduled, event_completed]

WorkflowRule

{
  "actions": [
    {
      "created_at": "2024-01-15T10:30:00Z",
      "id": "waction_def456",
      "properties": {
        "recipient": "attendee",
        "template": "confirmation"
      },
      "type": "send_custom_email"
    }
  ],
  "created_at": "2024-01-15T10:30:00Z",
  "id": "wrule_abc123",
  "trigger_offset_amount": 10,
  "trigger_offset_direction": "after",
  "trigger_offset_unit": "minutes",
  "trigger_type": "event_created"
}