v1

latestOpenAPI 3.1.0MIT2026-07-26134154266.9 KB
Workflows (Beta)

[Beta] Validate a workflow definition

Validate workflow blocks without creating a workflow. Runs both the structural check and the deep semantic validation the dashboard editor runs on Save (action inputs against each action's input schema, trigger configuration against the trigger's configuration_def). Returns validation issues and the list of action types used. Use this before creating or updating a workflow to catch errors early.

post/workflows/validate

Request body

trigger_type'manual-trigger' | 'ai-trigger' | 'cron-trigger' | 'form-trigger' | 'webhook' | 'contact-created' | 'contact-updated' | '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' required

Trigger type to validate against

{"stackTrail":"components:schemas:ValidateWorkflowPublicInput:properties:trigger_configuration:anyOf","oasType":"schema","type":"unknown","description":"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.","nullable":true}

Response

Default Response

validboolean required

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

action_types_usedstring[] required

List of action types referenced in the workflow