Workflows API

Create and manage automated workflows that define sequences of actions

Available Endpoints

The Workflow Object

hashid string

System-generated unique identifier

actions_count integer

Number of actions in the workflow

created_at string

Created at in specified timezone

created_at_string string

Created at formatted as human-readable string

created_at_utc string

Created at in UTC

default_template boolean

Whether this is a default template for new users (Admin only)

description string

Description of the workflow

event_trigger object

Event trigger configuration

event_trigger_draft object

Draft event trigger configuration

executions_count integer

Number of times workflow has been executed

groups array

Permission groups (Admin only)

has_draft boolean

Whether the workflow has unsaved draft changes

id string

Unique identifier

key string

Unique key for the workflow

last_published_at string

Last published at in specified timezone

last_published_at_string string

Last published at formatted as human-readable string

last_published_at_utc string

Last published at in UTC

match_conditions object

Conditions for matching workflow execution

match_conditions_draft object

Draft conditions for matching workflow execution

name string

Name of the workflow

object string

Object type identifier

on boolean

Whether the workflow is enabled

stats object

Workflow execution statistics

status string

Current status of the workflow

template object

Published workflow template layout

template_draft object

Draft workflow template layout

trigger_conditions object

Conditions for triggering the workflow

trigger_conditions_draft object

Draft conditions for triggering the workflow

updated_at string

Updated at in specified timezone

updated_at_string string

Updated at formatted as human-readable string

updated_at_utc string

Updated at in UTC

Workflow Object
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
{
  "hashid": "3bvde",
  "actions_count": 0,
  "created_at": "2025-07-13T01:01:17-04:00",
  "created_at_string": "Jul 13, 2025 01:01 am EDT",
  "created_at_utc": "2025-07-13T05:01:17Z",
  "description": null,
  "event_trigger": null,
  "event_trigger_draft": null,
  "executions_count": 0,
  "has_draft": false,
  "id": "01980228-ad8e-7049-8db0-551e461b6fc6",
  "key": "workflow_11",
  "last_published_at": null,
  "last_published_at_string": null,
  "last_published_at_utc": null,
  "match_conditions": null,
  "match_conditions_draft": null,
  "name": "Workflow 11",
  "object": "workflow",
  "on": false,
  "status": "off",
  "trigger_conditions": {},
  "trigger_conditions_draft": {},
  "updated_at": "2025-07-13T01:01:17-04:00",
  "updated_at_string": "Jul 13, 2025 01:01 am EDT",
  "updated_at_utc": "2025-07-13T05:01:17Z"
}