Skip to main content
cURL
curl --request POST \
  --url https://api.simplex.sh/run_workflow \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "metadata": "<string>",
  "webhook_url": "<string>",
  "variables": {
    "username": "john_doe",
    "product_id": "12345",
    "quantity": 2
  }
}'
{
  "succeeded": true,
  "session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
Runs a saved workflow.

Authorizations

​
X-API-Key
string
header
required

Simplex API Key

Body

application/json
​
workflow_id
string<uuid>
required

The ID of the workflow to run.

​
metadata
string

JSON string containing metadata for the workflow. This metadata is passed back to you in the webhook response.

​
webhook_url
string

Optional webhook URL to test workflow changes on. Often an ngrok URL of a local version of your application.

​
variables
object

JSON object containing variables to pass to the workflow.

Example:
{
  "username": "john_doe",
  "product_id": "12345",
  "quantity": 2
}

Response

Run workflow response

​
succeeded
boolean
required

Whether the workflow ran successfully.

​
session_id
string<uuid>

The session ID for the workflow.

​
workflow_id
string<uuid>

The workflow ID.

⌘I