Overview

Use the API trigger to start a workflow from your backend or script. Add an API trigger in the workflow builder and set the HTTP method (GET, POST, PUT, or PATCH) to match how you will call the endpoint.

Base URL

All client API requests use this base URL:

https://api.flowfn.com/v1

Paths below are relative to this base (e.g. app/workflow/api/:workflow → https://api.flowfn.com/v1/app/workflow/api/:workflow).

Endpoint

POST app/workflow/api/:workflow
GET, POST, PUT, or PATCH (method must match the workflow's API trigger configuration)

Headers

Send these headers with your app credentials:

x-api-key: your-app-api-key
x-app-code: your-app-code

Identifying the workflow

Pass the workflow code in the endpoint path as :workflow. Request body fields are passed as trigger inputs to the workflow.

// Example request body (POST app/workflow/api/your-workflow-code)
{
  "key": "value"
}

Response

Returns workflow_id, trigger_id, run_id, run_code, and a message. To fetch the run later with app credentials:

GET app/runs/:id
Headers: x-api-key, x-app-code

Version behavior

API-triggered runtime executions resolve to the published active version for the given app code + workflow code. Use test runs in the dashboard when you need to execute a non-published version.

Triggering Workflows via API