For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
GuidesAPI ReferenceChangelogModel Versioning
GuidesAPI ReferenceChangelogModel Versioning
    • Getting Started
    • Authentication
    • API Versioning
    • SDKs
    • Deployments
    • Error Codes
    • Async Processing
  • Endpoints
  • Webhook Events
      • POSTWorkflow Run Completed
      • POSTWorkflow Run Failed
      • POSTWorkflow Run Needs Review
      • POSTWorkflow Run Rejected
      • POSTWorkflow Run Cancelled
      • POSTWorkflow Run Step Run Processed
      • POSTWorkflow Created
      • POSTWorkflow Deployed
      • POSTWorkflow Deleted
LogoLogo
Webhook EventsWorkflow

Workflow Created

Payload
1{
2  "eventId": "string",
3  "payload": {
4    "object": "workflow",
5    "id": "workflow_BMlfq_yWM3sT-ZzvCnA3f",
6    "name": "Invoice Processing",
7    "createdAt": "2024-03-21T16:45:00Z",
8    "updatedAt": "2024-03-21T16:45:00Z",
9    "draftVersion": {
10      "object": "workflow_version",
11      "id": "workflow_version_Zk9mNP12Qw4-yTv8BdR3H",
12      "version": "1",
13      "name": "Production v1",
14      "steps": [
15        {
16          "name": "string",
17          "type": "TRIGGER"
18        }
19      ],
20      "createdAt": "2024-03-21T16:45:00Z"
21    }
22  },
23  "eventType": "workflow.created"
24}
Was this page helpful?
Previous

Workflow Deployed

Next
Built with

Payload

The payload of this webhook request is an object.
eventIdstringRequired
Unique identifier for the event
payloadobjectRequired
A workflow with its draft version and steps.

Response

200
Return a 200 status to indicate that the webhook was received successfully