v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB

Workflows API

Activate a Workflow

Use this endpoint to activate a workflow. Transitions the status from draft to active.

post/v1/workflows/{id}/activate

Path parameters

idstring uuid required

Unique identifier of the workflow.

Response

Indicates that the request was successful and the response contains the requested data.

createdAtstring date-time

Timestamp when the workflow was created.

descriptionstring

Human-readable description of the workflow.

idstring uuid

Unique identifier of the workflow.

metadataobject

Custom key-value pairs for tagging or categorizing.

namestring

Unique name of the workflow.

status'draft' | 'active' | 'inactive'

Current lifecycle status: draft (editable), active (executable), or inactive (archived).

updatedAtstring date-time

Timestamp of the last update.

Example response

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "name": "Payment Notification Flow",
  "description": "Receives a webhook trigger and logs the payment event.",
  "status": "active",
  "nodes": [
    {
      "id": "trigger-1",
      "type": "trigger",
      "name": "Webhook Trigger",
      "position": {
        "x": 0,
        "y": 0
      },
      "data": {
        "triggerId": "webhook"
      }
    },
    {
      "id": "log-event",
      "type": "action",
      "name": "Log Payment Event",
      "position": {
        "x": 200,
        "y": 0
      },
      "data": {
        "action": "log"
      }
    }
  ],
  "edges": [
    {
      "id": "e1",
      "source": "trigger-1",
      "target": "log-event"
    }
  ],
  "metadata": {
    "team": "payments",
    "environment": "sandbox"
  },
  "createdAt": "2026-03-17T14:30:00Z",
  "updatedAt": "2026-03-17T14:31:00Z"
}