V2 Automations

List automation connections (v2)

get

Returns stored workspace connections. Secret values are never returned.

Responses
chevron-right
200

Automation connections retrieved successfully

application/json
idstring · uuidOptional
namestringOptional
typestringOptional
scopestringOptional
activebooleanOptional
get
/api/v2/automation-connections

Create automation connection (v2)

post

Creates one stored workspace connection for http_request actions. Secret values are write-only.

Body
namestringOptional
typestringOptional
scopestringOptional
ownerMemberIdstring · uuidOptional
activebooleanOptional
Responses
post
/api/v2/automation-connections

Get automation connection (v2)

get

Returns one stored connection. Secret values are never returned.

Responses
chevron-right
200

Automation connection retrieved successfully

application/json
idstring · uuidOptional
namestringOptional
typestringOptional
scopestringOptional
ownerMemberIdstring · uuidOptional
activebooleanOptional
createdAtstring · date-timeOptional
updatedAtstring · date-timeOptional
createdBystringOptional
updatedBystringOptional
get
/api/v2/automation-connections/{connectionId}

Delete automation connection (v2)

delete

Deletes one stored connection.

Responses
chevron-right
200

Automation connection deleted successfully

application/json
anyOptional
delete
/api/v2/automation-connections/{connectionId}

No content

Patch automation connection (v2)

patch

Patches one stored connection. Use set.secret only when rotating secrets.

Body
unsetstring[]Optional
Responses
chevron-right
200

Automation connection patched successfully

application/json
idstring · uuidOptional
namestringOptional
typestringOptional
scopestringOptional
ownerMemberIdstring · uuidOptional
activebooleanOptional
createdAtstring · date-timeOptional
updatedAtstring · date-timeOptional
createdBystringOptional
updatedBystringOptional
patch
/api/v2/automation-connections/{connectionId}

List automation folders (v2)

get

Returns the flat public folder projection over legacy workflow groups.

Responses
chevron-right
200

Automation folders retrieved successfully

application/json
idstring · uuidOptional
namestringOptional
isRootbooleanOptional
automationCountinteger · int32Optional
get
/api/v2/automation-folders

Create automation folder (v2)

post

Creates one flat automation folder.

Body
namestringOptional
Responses
post
/api/v2/automation-folders

Delete automation folder (v2)

delete

Deletes one non-root automation folder.

Responses
chevron-right
200

Automation folder deleted successfully

application/json
idstring · uuidOptional
namestringOptional
isRootbooleanOptional
automationCountinteger · int32Optional
delete
/api/v2/automation-folders/{folderId}

Patch automation folder (v2)

patch

Renames one automation folder.

Body
namestringOptional
Responses
chevron-right
200

Automation folder patched successfully

application/json
idstring · uuidOptional
namestringOptional
isRootbooleanOptional
automationCountinteger · int32Optional
patch
/api/v2/automation-folders/{folderId}

Move automation to folder (v2)

post

Moves one automation into a target flat folder.

Body
automationIdstring · uuidOptional
Responses
chevron-right
200

Automation moved successfully

application/json
idstring · uuidOptional
namestringOptional
isRootbooleanOptional
post
/api/v2/automation-folders/{folderId}/automations:move

List automation plugins (v2)

get

Returns active workspace plugins available for execute_plugin actions.

Responses
chevron-right
200

Automation plugins retrieved successfully

application/json
idstringOptional
namestringOptional
activebooleanOptional
descriptionstringOptional
get
/api/v2/automation-plugins

Get automation plugin (v2)

get

Returns one active workspace plugin by id.

Responses
chevron-right
200

Automation plugin retrieved successfully

application/json
idstringOptional
namestringOptional
activebooleanOptional
descriptionstringOptional
get
/api/v2/automation-plugins/{pluginId}

List automations (v2)

get

Returns automation summaries with optional filters by folder, status, trigger type, action type, plugin, and search.

Responses
chevron-right
200

Automation list retrieved successfully

application/json
idstring · uuidOptional
namestringOptional
descriptionstringOptional
statusstringOptional
triggerTypestringOptional
actionTypesstring[]Optional
get
/api/v2/automations

Create automation (v2)

post

Creates one automation. Agents should provide a complete trigger and a frontend-meaningful configuration, not just a minimally valid payload.

Body
namestringOptional
descriptionstringOptional
folderIdstring · uuidOptional
Responses
post
/api/v2/automations

Get automation (v2)

get

Returns the full public automation document including trigger, actions, and flow.

Responses
chevron-right
200

Automation retrieved successfully

application/json
idstring · uuidOptional
namestringOptional
descriptionstringOptional
statusstringOptional
get
/api/v2/automations/{automationId}

Delete automation (v2)

delete

Deletes one automation.

Responses
chevron-right
200

Automation deleted successfully

application/json
automationIdstring · uuidOptional
delete
/api/v2/automations/{automationId}

Patch automation metadata (v2)

patch

Updates only top-level metadata. Supported patch paths: name, description, folderId.

Body
unsetstring[]Optional
Responses
chevron-right
200

Automation patched successfully

application/json
anyOptional
patch
/api/v2/automations/{automationId}

No content

List actions (v2)

get

Returns the ordered list of public actions for one automation.

Responses
chevron-right
200

Actions retrieved successfully

application/json
idstring · uuidOptional
typestringOptional
namestringOptional
configone ofOptional
or
or
or
or
or
get
/api/v2/automations/{automationId}/actions

Add action (v2)

post

Adds one action. For record-based actions, populate visible fieldMapping so the frontend form is complete.

Body
typestringOptional
namestringOptional
configone ofOptional
or
or
or
or
or
Responses
post
/api/v2/automations/{automationId}/actions

No content

Update action (v2)

put

Replaces one action payload.

Body
typestringOptional
namestringOptional
configone ofOptional
or
or
or
or
or
Responses
chevron-right
200

Action updated successfully

application/json
idstring · uuidOptional
typestringOptional
namestringOptional
configone ofOptional
or
or
or
or
or
put
/api/v2/automations/{automationId}/actions/{actionId}

Delete action (v2)

delete

Deletes one action from the automation.

Responses
chevron-right
200

Action deleted successfully

application/json
automationIdstring · uuidOptional
delete
/api/v2/automations/{automationId}/actions/{actionId}

Get flow (v2)

get

Returns the public flow subresource.

Responses
chevron-right
200

Flow retrieved successfully

application/json
entryActionIdsstring · uuid[]Optional
get
/api/v2/automations/{automationId}/flow

Replace flow (v2)

put

Replaces entry actions and transitions for the automation.

Body
entryActionIdsstring · uuid[]Optional
Responses
chevron-right
200

Flow replaced successfully

application/json
anyOptional
put
/api/v2/automations/{automationId}/flow

No content

Get trigger (v2)

get

Returns the public trigger subresource.

Responses
chevron-right
200

Trigger retrieved successfully

application/json
typestringOptional
configone ofOptional
or
or
or
get
/api/v2/automations/{automationId}/trigger

Replace trigger (v2)

put

Replaces the automation trigger. For record_created and record_changed, agents should provide at least one meaningful condition for frontend-complete workflows.

Body
typestringOptional
configone ofOptional
or
or
or
Responses
chevron-right
200

Trigger replaced successfully

application/json
anyOptional
put
/api/v2/automations/{automationId}/trigger

No content

Get webhook endpoint (v2)

get

Returns the webhook endpoint companion resource for an automation.

Responses
chevron-right
200

Webhook endpoint retrieved successfully

application/json
endpointIdstring · uuidOptional
automationIdstring · uuidOptional
endpointUrlstringOptional
activebooleanOptional
idempotencyKeyJsonPathstringOptional
eventTypeJsonPathstringOptional
allowedEventTypesstring[]Optional
get
/api/v2/automations/{automationId}/webhook-endpoint

Create or update webhook endpoint (v2)

put

Creates or updates the webhook endpoint companion resource.

Body
idempotencyKeyJsonPathstringOptional
eventTypeJsonPathstringOptional
allowedEventTypesstring[]Optional
activebooleanOptional
Responses
chevron-right
200

Webhook endpoint saved successfully

application/json
endpointIdstring · uuidOptional
automationIdstring · uuidOptional
endpointUrlstringOptional
activebooleanOptional
idempotencyKeyJsonPathstringOptional
eventTypeJsonPathstringOptional
allowedEventTypesstring[]Optional
put
/api/v2/automations/{automationId}/webhook-endpoint

Delete webhook endpoint (v2)

delete

Deletes the webhook endpoint companion resource.

Responses
chevron-right
200

Webhook endpoint deleted successfully

application/json
anyOptional
delete
/api/v2/automations/{automationId}/webhook-endpoint

No content

Activate automation (v2)

post

Transitions one automation to active.

Responses
chevron-right
200

Automation activated successfully

application/json
automationIdstring · uuidOptional
post
/api/v2/automations/{automationId}:activate

Deactivate automation (v2)

post

Transitions one automation to inactive.

Responses
chevron-right
200

Automation deactivated successfully

application/json
automationIdstring · uuidOptional
post
/api/v2/automations/{automationId}:deactivate

Last updated