Workflows

List workflow rules

get/v1/workflows/{workflow_id}/rules

Request

Path parameters

workflow_idstring required

Response

Success

created_atstring date-time required
idstring required
trigger_offset_amountinteger required

How long before or after the trigger the actions run, in trigger_offset_unit

trigger_offset_direction'before' | 'after' required
trigger_offset_unit'minutes' | 'hours' | 'days' required
trigger_type'event_created' | 'event_started' | 'event_ended' required

Example response

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

Changes

No recorded changes to this operation across all 1 revision of this API.