Automation Definitions
Automations allow you to set triggers and define actions so the system can execute tasks for your team to help streamline content workflows. You can integrate entities like AI Actions and Workflows into these automations.
An automation definition includes a series of steps that execute when a trigger occurs. Automation definitions are environment-scoped, meaning each automation is associated with a specific space and environment.
To learn how to use automations in the web app, refer to Automations in our Help Center.
Automations are available on Pro plans and above. Only space admins can create, edit, and delete automation definitions.
An automation definition includes the following components:
- Name: A human-readable name for the automation.
- Description: Optional descriptive text explaining the automation’s purpose.
- Triggers: Events (scheduled or event-based) that initiate the automation.
- Steps: An array of actions, conditions, and loops defining the automation’s behavior.
Step Types
Automation definitions collection
Create an automation definition
Use this endpoint to create a new automation definition in the specified environment.
Get all automation definitions
Returns all automation definitions that exist in a given environment.
Automation definition
Use this endpoint to retrieve a specific automation definition by its ID.
Update an automation definition
Use this endpoint to update an automation definition for a specified environment.
Delete an automation definition
Use this endpoint to delete an automation definition for a specified environment.