Run a workflow by webhook or API

Only published workflows run from outside the designer. There are two ways in: a webhook URL that any system can call, and the API for your own code.

Before you start

• A published workflow. A draft triggered by webhook gets 409 WORKFLOW_NOT_PUBLISHED.
• For the webhook: its URL and trigger token, from the Webhook trigger panel in the designer.
• For the API: your secret sk-so- key from API keys. See API keys.

Steps: webhook

1. 1

   Copy the URL and token

   In the designer, open Webhook trigger and use Copy URL. The token starts with wft_ and is shown once; store it in your secrets. Only a SHA-256 hash of it is kept.

2. 2

   Send the input as JSON

   POST a JSON object to the URL with the token in the X-Workflow-Token header (or ?token=). The body becomes the Start input; it can be up to 100 KB.

   curl -X POST "https://app.sentientone.ai/api/workflows/hooks/$WORKFLOW_ID?wait=true" \  -H "Content-Type: application/json" \  -H "X-Workflow-Token: $WORKFLOW_TOKEN" \  -d '{"email": "sam@example.com", "message": "My invoice is wrong"}'

3. 3

   Read the answer

   Without ?wait=true the call answers 202 straight away with the run id. With ?wait=true it waits up to 30 seconds and returns the finished run, or 202 with status running if it takes longer.

   HTTP/1.1 202 Accepted{"run_id": "8d1f…", "status": "queued"}

Steps: from your code

POST https://api.sentientone.ai/v1/workflows/run with X-Api-Key, the workflow_id, input and mode: "live". It streams each step as server-sent events, or returns the finished run as JSON with "stream": false. Full reference: Workflows API.

curl https://api.sentientone.ai/v1/workflows/run \  -H "Content-Type: application/json" \  -H "X-Api-Key: $SENTIENTONE_API_KEY" \  -d '{"workflow_id": "…", "mode": "live", "stream": false,       "input": {"email": "sam@example.com", "message": "My invoice is wrong"}}'

Rotating the trigger token

Rotate the token from the Webhook trigger panel if it leaks. The old token stops working immediately, so update every caller first or straight after.

If something goes wrong