List Workflow Automations

Required scope: workflow_automation:read

Workflow automations run on their own triggers inside HeyX. The public API offers read-only discovery — list and get — and does not launch or edit automations. To drive an event-triggered automation from an integration, publish a customer event with CreateCustomerEvent; the matching automation reacts on its own schedule.

Only published, non-archived automations appear here. definitionType filters by trigger style: triggered reacts to events, polling runs on a schedule. subjectType filters by the record an automation acts on, such as customer, appointment, work_order, problem, advanced_task, order, or correspondence.

Results use stable newest-first cursor pagination. Pass nextCursor from one response as cursor on the next request. A page may hold fewer than pageSize entries after unpublished and filtered-out automations are dropped, so continue until nextCursor is absent or empty rather than stopping on a short page.

Generated Reference

POST /public-api/publicapi.v1.WorkflowAutomation/ListWorkflowAutomations

Lists published workflow automations, newest first. Draft automations that were never published and archived automations are omitted.

Request ListWorkflowAutomationsRequest

Response ListWorkflowAutomationsResponse

ListWorkflowAutomationsRequest

Field	Type	Description
definition_type	optional string	Filters by how the automation starts: "triggered" reacts to record events, "polling" runs on a schedule. Omit to list both kinds.
subject_type	optional string	Filters by the record the automation acts on, for example "customer", "appointment", "work_order", or "problem". Omit to list every subject.
page_size	int32	Maximum automations to return. Defaults to 25 and is capped at 100.
cursor	optional string	Opaque continuation token from a previous response's next_cursor.

ListWorkflowAutomationsResponse

Field	Type	Description
automations	repeated WorkflowAutomation	Published, non-archived automations for this page, newest first. May hold fewer than page_size entries; keep paging until next_cursor is empty.
next_cursor	optional string	Present when more automations are available; pass it back as cursor.

Related Types

WorkflowAutomation

Field	Type	Description
workflow_automation_id	string	Stable identifier of the automation; pass to GetWorkflowAutomation.
display_name	string	Human-readable automation name.
definition_type	string	How the automation starts: "triggered" (record events) or "polling".
subject_type	string	The record the automation acts on, for example "customer" or "work_order".
current_version_number	int32	The currently published version number, starting at 1.
created_at	int64	Automation creation time, unix seconds.
updated_at	int64	Automation last-modified time, unix seconds.
archived	bool	True when the automation has been archived and no longer runs.

Request

{
  "definitionType": "triggered",
  "subjectType": "customer",
  "pageSize": 25
}

Response

{
  "automations": [
    {
      "workflowAutomationId": "d6d1d3f6-3d2f-4c0a-9f3f-9a4a2b7c1e10",
      "displayName": "Welcome new customers",
      "definitionType": "triggered",
      "subjectType": "customer",
      "currentVersionNumber": 3,
      "createdAt": "1784548800",
      "updatedAt": "1786190400",
      "archived": false
    }
  ],
  "nextCursor": "eyJjcmVhdGVkX2F0IjoiLi4uIn0"
}