Skip to main content
POST
[Beta] Validate a workflow definition

Authorizations

Authorization
string
header
required

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

Body

application/json
trigger_type
enum<string>
required

Trigger type to validate against

Available options:
manual-trigger,
ai-trigger,
cron-trigger,
form-trigger,
webhook,
contact-created,
phone-call-started,
phone-call-finished,
ticket-created,
ticket-reassigned,
ticket-resolved,
ticket-handoff,
pre-ticket-handoff,
ticket-tag-added,
ticket-inactive,
agent-inactive,
sequence-completed,
csat-score-submit,
prohibited-topic-detected,
sla-first-reply-breached,
sla-next-reply-breached,
sla-resolution-breached,
voice-call-transferred,
pre-voice-call-transfer,
pre-phone-call-finished,
manual-ticket-trigger,
contact-message-received,
first-contact-message-received,
macro-called,
ai-response-completed,
agent-availability-changed,
agent-avail-in-team-changed,
ai-response-requested,
ticket-reopened
workflow_blocks
any[]
required

Workflow blocks to validate

trigger_configuration
any | null

Trigger configuration to validate against the trigger's configuration_def. When omitted, the trigger is validated as if unconfigured — triggers with required configuration (e.g. cron-trigger, ai-trigger) will report errors.

Response

Default Response

valid
boolean
required

Whether the workflow definition is valid (no error-severity issues)

issues
object[]
required

List of validation issues found

action_types_used
string[]
required

List of action types referenced in the workflow