Skip to main content
POST
/
client
/
workflows
/
{workflow_id}
/
test
Trigger a test workflow execution
curl --request POST \
  --url http://localhost:8080/api/v1/client/workflows/{workflow_id}/test \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contact_id": 123,
  "respect_send_window": false
}
'
{
  "data": {
    "contact_id": 123,
    "execution_id": 123,
    "is_test": true,
    "processed_at": "<string>",
    "queue_id": 123,
    "reason": "<string>",
    "status_text": "<string>",
    "workflow_id": 123
  },
  "errors": [
    {
      "condition": "format",
      "error": "Invalid email format",
      "key": "email"
    }
  ],
  "message": "Operation successful",
  "meta": {},
  "success": true
}

Authorizations

​
Authorization
string
header
required

JWT Bearer token or raw API key via Authorization header

Path Parameters

​
workflow_id
integer
required

Workflow ID

Body

application/json

Test trigger request

​
contact_id
integer
Example:

123

​
respect_send_window
boolean
Example:

false

Response

Accepted

​
data
object
​
errors
object[]
​
message
string
Example:

"Operation successful"

​
meta
object
​
success
boolean
Example:

true