POST /v1/automation/workflows/simulate-definition

POST/v1/automation/workflows/simulate-definition

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Request body

requiredapplication/json

definitionanyrequired

mock_outputsobject

triggerSimulateTriggerInput

Show properties

event_typestringrequired

payloadanyrequired

Responses

200OK

errorsstring[] | null

selected_outcomesobject

validbooleanrequired

visited_nodesstring[] | null

defaultError

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X POST "/v1/automation/workflows/simulate-definition" \
  -H "Content-Type: application/json" \
  -d '{
  "definition": "string",
  "mock_outputs": {},
  "trigger": {
    "event_type": "string",
    "payload": "string"
  }
}'

const response = await fetch("/v1/automation/workflows/simulate-definition", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "definition": "string",
  "mock_outputs": {},
  "trigger": {
    "event_type": "string",
    "payload": "string"
  }
})
});

import requests

response = requests.post(
    "/v1/automation/workflows/simulate-definition",
    headers={
        "Content-Type": "application/json"
    },
    json={
  "definition": "string",
  "mock_outputs": {},
  "trigger": {
    "event_type": "string",
    "payload": "string"
  }
},
)

Response

{
  "errors": [
    "string"
  ],
  "selected_outcomes": {},
  "valid": true,
  "visited_nodes": [
    "string"
  ]
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}