Workflows API – Create, Publish and Monitor Workflows by API
You can now build and manage workflows from your own code. The new Workflows API, now in private beta, creates, reads, updates, publishes and deletes workflows, and reads each workflow's execution logs and statistics. ✅…
You can now build and manage workflows from your own code. The new Workflows API, now in private beta, creates, reads, updates, publishes and deletes workflows, and reads each workflow's execution logs and statistics.
✅ What's New- Create workflows – Create a workflow from a complete definition. New workflows start as drafts.
- Read and update workflows – Read any workflow as a definition you can change and send back.
- Validate before saving – Check a definition for errors without saving it, with each error pointing at the exact step.
- Publish or unpublish – Publish a workflow, or set it back to draft.
- Search and delete – Find workflows by name, status, folder or date, and delete workflows.
- Step types – Browse every trigger and action available in the sub-account, with its fields.
- Execution logs – See who entered a workflow, what happened at each step and which steps failed, with the error.
- Statistics – Count enrollments, completions and failures per step, by hour, day or week.
With the Workflows API, you can:
- Roll out the same workflow to many sub-accounts without rebuilding it by hand.
- Catch failing steps from your own monitoring instead of opening each workflow.
- Let your own app or AI agent build workflows for your clients.
💡 Example Use Cases
Standard rollout
Read a workflow from your template sub-account → create it in each client sub-account → publish it.
Failure report
Every Monday, count failures per step for your key workflows → list who was affected → send the summary to your team.
Onboarding from your app
A client signs up in your product → your app creates and publishes their onboarding workflow in their sub-account.
🔌 How to Get Started
- In the sub-account, go to Settings → Private Integrations, create an integration and select the workflow scopes you need: View Workflows, Edit Workflows, Publish Workflows, Delete Workflows and View Workflow Logs.
- Send the token as a bearer token, with the Version: v3 header and the sub-account's locationId on every request.
- Use the Workflows API reference for every endpoint and its fields. Each endpoint page has a request panel to try it with your token.
⚠️ Notes & Details
- Private beta: the Workflows API is enabled for selected sub-accounts. Others get a 403 with WORKFLOW_API_NOT_ENABLED_FOR_LOCATION. Contact support to join.
- Updates replace the whole workflow, so read it first and send back the version you read.
- To edit a published workflow, set it to draft first. While it's a draft, its triggers are off and contacts in it are paused.
- App steps only accept an app account that's already connected in the sub-account.
- Deleting a workflow is permanent and stops everyone currently in it.
- Logs cover up to 30 days per request and go back 60 days. They show live runs; test runs from the builder aren't included.
Support doc Here