Skip to main content
POST
/
api
/
workflows
/
nodes
/
{type}
/
test
Validate and dry-run a single workflow node definition
curl --request POST \
  --url https://your-instance.example.com/api/workflows/nodes/{type}/test \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "config": {
    "webhookId": "wh_64d2f9c5e8a1d4e001a0b1c3"
  },
  "input": {
    "webhookId": "wh_64d2f9c5e8a1d4e001a0b1c3",
    "payload": {
      "lead": {
        "name": "Alex Nguyen",
        "email": "alex.nguyen@example.com"
      }
    }
  }
}
'
{
  "success": true,
  "output": {
    "webhookId": "wh_64d2f9c5e8a1d4e001a0b1c3",
    "payload": {
      "lead": {
        "name": "Alex Nguyen",
        "email": "alex.nguyen@example.com"
      }
    }
  },
  "durationMs": 4
}

Documentation Index

Fetch the complete documentation index at: https://docs.tetherai.ca/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
type
string
required

Registered node type (e.g. WebhookTrigger, SendMessage, IfCondition).

Body

application/json

config is parsed against the node's configSchema. input is only consumed by trigger-category nodes; for non-trigger nodes it is ignored and a mocked outputShape is returned. Trigger nodes receive input flattened into an ExecutionContext (so fields like contactId, messageId, from/to/subject are read from the top level).

​
config
any

Node-specific configuration to validate.

​
input
any

Trigger input payload. Ignored for non-trigger nodes.

Response

Test executed (success, mocked output, or validation failure). Inspect success to disambiguate.

Always 200 OK. Inspect success to disambiguate: true → trigger executed or non-trigger returned a mocked outputShape; false → config validation failed (issues array populated) OR WebhookTrigger boundary-check failed.

​
success
boolean
required
​
durationMs
integer
required
​
output
object

Real trigger output, or mocked outputShape keys tagged with their declared type for side-effecting nodes.

​
message
string
​
issues
object[]