Automation executions
An automation execution is one run of an automation built in the AchieveApex app. Create one to run an automation with your own input data (for example a conversation and its contact), then read it to follow its status and result. Automations themselves are built in the app; get the automation_id from the automation's page.
Endpoints
| Method | Path | Description |
|---|---|---|
POST | /automations-executions | Run an automation |
GET | /automations-executions | List executions |
GET | /automations-executions/:id | Get an execution |
The execution object
json
Fields
| Field | Type | Description |
|---|---|---|
id | integer | Read-only. Unique ID. |
automation_id | integer | Automation that runs. Required on create. |
organization_id | integer | Organization. Required on create. |
conversation_id | integer | null | Conversation the run is about. Logged in the conversation timeline. |
ticket_id | integer | null | Support ticket the run is about. Logged in the ticket. |
contact_id | integer | null | Contact the run is about. |
triggered_by_user_id | integer | null | User who started the run. |
triggered_by_ai_assistant_id | integer | null | AI assistant that started the run. |
campaign_id | integer | null | Campaign that started the run. |
series_id / series_step_id / series_subscription_id | integer | null | Series (drip sequence) step that started the run. |
initial_payload | object | null | Input data available to every node of the automation. |
automation_flow | object | null | Read-only. Copy of the automation's nodes and edges at the time of the run. |
status | string | Read-only. pending, running, completed, failed or cancelled. |
error_message | string | null | Read-only. Error when the run failed. |
response_body | object | null | Read-only. Output of the last completed node, set when the run completes. |
started_at | string (date-time) | null | Read-only. |
completed_at | string (date-time) | null | Read-only. |
created_at | string (date-time) | Read-only. |
updated_at | string (date-time) | Read-only. |
deleted_at | string (date-time) | null | Read-only. |
Report an issue with this documentation
Please log in to report issues with our documentation.