Flows

Overview

Journeys — the automation graphs built in the Flow Builder. List the published ones and trigger a specific flow against a contact, which is how you start an onboarding or post-purchase sequence from your own system.

2 endpoints. Requires flows.view or flows.manage on the token.

Method	Path	What it does
GET	/flows	List flows
POST	/flows/trigger	Trigger a flow

Endpoints

GET /flows

List flows

List all active automation flows. Requires `flows.view` permission.

Requires the flows.view permission.

Example

curl -X GET "https://orqestra.id/api/v2/flows" \
  -H "Authorization: Bearer $ORQESTRA_TOKEN"

Responds with 200 · 401 · 403. Try it in the playground →

---

POST /flows/trigger

Trigger a flow

Trigger an automation flow for a contact. Resolves by ID or keyword. Consumes flow_trigger credits.

Requires the flows.manage permission.

Request body

Field	Type	Required	Description
to	string	required	Contact phone number
channelId	string	optional	OrgChannel ID for chat resolution
flowId	string	optional	Flow ID (provide this or flowKeyword)
flowKeyword	string	optional	Keyword trigger (provide this or flowId)

Example

curl -X POST "https://orqestra.id/api/v2/flows/trigger" \
  -H "Authorization: Bearer $ORQESTRA_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "628123456789"
  }'

Responds with 200 · 400 · 401 · 403 · 404 · 429. Try it in the playground →