Manually trigger a published workflow.

Authorization

AuthorizationBearer <token>

Rensei API key presented as Authorization: Bearer rsk_live_. Required API-key scopes are recorded per operation in x-rensei-required-scopes.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

params?

Trigger params surfaced as trigger.data.

poolId?string

Per-dispatch execution-pool override.

triggerId?string

Scope a multi-trigger workflow to a single trigger node.

mode?string

Synchronous launch-return mode. Only valid for a workflow whose canvas contains an interactive.session.launch node: the instance runs INLINE up to the fire-and-suspend wait gate and the response carries the launched sessionId/metaId synchronously (the instance then parks on the wait gate as usual). Omit for the default fire-and-forget behaviour.

Response Body

`application/json`

curl -X POST "https://example.com/api/workflows/string/trigger" \  -H "Content-Type: application/json" \  -d '{}'

{
  "instanceId": "string",
  "workflowId": "string",
  "status": "string",
  "sessionId": "string",
  "metaId": "string"
}

Empty

{
  "error": "string",
  "code": "string",
  "details": {
    "errors": [
      {
        "path": "string",
        "message": "string"
      }
    ]
  }
}

Empty

Manually trigger a published workflow.

Authorization

Path Parameters

Request Body

Response Body

200application/json

400

401

404

409

422application/json

500

`application/json`

`application/json`