Skip to content
HeyX API

Get Workflow Automation

Required scope: workflow_automation:read

Returns one published workflow automation together with its current published version. Automations that only exist as an unpublished draft, and archived automations, are reported as not_found. The response describes what the automation reacts to (definitionType, subjectType) and which version is live; it does not return the automation’s internal step definition.

Workflow automations run on their own triggers. To drive an event-triggered automation, publish a customer event; this endpoint does not launch automations.

Generated Reference
POST /public-api/publicapi.v1.WorkflowAutomation/GetWorkflowAutomation

Returns one published workflow automation and its current published version metadata. Responds not_found when the id has never been published.

Request GetWorkflowAutomationRequest
Response GetWorkflowAutomationResponse

GetWorkflowAutomationRequest

Field Type Description
workflow_automation_id string Identifier of the automation to read, from ListWorkflowAutomations.

GetWorkflowAutomationResponse

Field Type Description
automation WorkflowAutomation The requested published automation summary, excluding its definition.
current_version WorkflowAutomationVersion Coarse metadata for the automation's current published version.

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.

WorkflowAutomationVersion

Field Type Description
version_id string Stable identifier of this version.
version_number int32 Sequential version number, starting at 1.
published_at int64 Publication time of this version, unix seconds.
is_current bool True when this is the automation's current published version.

Request

Section titled “Request”
{
  "workflowAutomationId": "d6d1d3f6-3d2f-4c0a-9f3f-9a4a2b7c1e10"
}

Response

Section titled “Response”
{
  "automation": {
    "workflowAutomationId": "d6d1d3f6-3d2f-4c0a-9f3f-9a4a2b7c1e10",
    "displayName": "Welcome new customers",
    "definitionType": "triggered",
    "subjectType": "customer",
    "currentVersionNumber": 3,
    "createdAt": "1784548800",
    "updatedAt": "1786190400",
    "archived": false
  },
  "currentVersion": {
    "versionId": "2f7b6c4e-9d21-4c88-bb0f-1e2a3b4c5d6e",
    "versionNumber": 3,
    "publishedAt": "1786190400",
    "isCurrent": true
  }
}
HeyX API