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

MethodPathDescription
POST/automations-executionsRun an automation
GET/automations-executionsList executions
GET/automations-executions/:idGet an execution

The execution object

json

Fields

FieldTypeDescription
idintegerRead-only. Unique ID.
automation_idintegerAutomation that runs. Required on create.
organization_idintegerOrganization. Required on create.
conversation_idinteger | nullConversation the run is about. Logged in the conversation timeline.
ticket_idinteger | nullSupport ticket the run is about. Logged in the ticket.
contact_idinteger | nullContact the run is about.
triggered_by_user_idinteger | nullUser who started the run.
triggered_by_ai_assistant_idinteger | nullAI assistant that started the run.
campaign_idinteger | nullCampaign that started the run.
series_id / series_step_id / series_subscription_idinteger | nullSeries (drip sequence) step that started the run.
initial_payloadobject | nullInput data available to every node of the automation.
automation_flowobject | nullRead-only. Copy of the automation's nodes and edges at the time of the run.
statusstringRead-only. pending, running, completed, failed or cancelled.
error_messagestring | nullRead-only. Error when the run failed.
response_bodyobject | nullRead-only. Output of the last completed node, set when the run completes.
started_atstring (date-time) | nullRead-only.
completed_atstring (date-time) | nullRead-only.
created_atstring (date-time)Read-only.
updated_atstring (date-time)Read-only.
deleted_atstring (date-time) | nullRead-only.

Report an issue with this documentation

Please log in to report issues with our documentation.