latestOpenAPI 3.1.02026-08-1014497184.0 KB

8b99dca11019

Execute workflow

Executes a workflow with the provided input parameters

post/workflows/runs

Request body

inputobject nullable

Optional JSON payload that will be passed as the workflow input context.

keystring required

The unique workflow key to execute (e.g. integration.stripe.charge.succeeded).

Example request

{
  "input": {
    "user": {
      "id": "123",
      "name": "John Doe"
    }
  },
  "key": "magicbell:signup"
}

Response

Created

idstring uuid required

Identifier of the workflow run that was created.

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000"
}