Automations
POST
Manually Trigger Automation
POST /v1/automations/{automationId}/triggerManually trigger an automation for testing or one-off execution.
Use Cases:
- Test an automation workflow with a specific contact
- Manually enroll a contact into an automation
- Trigger an automation outside of its normal trigger conditions
- Debug automation behavior with test contacts
Behavior:
- Enqueues the automation to run for the specified trigger event
- Automation must be in PUBLISHED status
- The trigger is processed asynchronously
- Returns immediately with confirmation
- Automation steps execute according to the workflow definition
Required Scope: write:automations
Prerequisites:
- Automation must be PUBLISHED
- Trigger data must match the automation's expected trigger type
Note: This endpoint is useful for testing and manual enrollment. For production use, automations are triggered automatically by the configured trigger events.
Path parameters
automationIdstringrequiredAutomation ID to trigger
Response
200Automation triggered successfully. The workflow will execute asynchronously.
objectstringrequiredidstringrequirednamestringrequireddescriptionanyrequiredstatus"DRAFT" | "PUBLISHED" | "ARCHIVED"requiredversionnumberrequiredparentIdanyrequiredtriggerobjectrequirednodesany[]requirededgesany[]requiredstatsanyrequiredpublishedAtanyrequiredcreatedAtstringrequiredupdatedAtstringrequired