Agentic - Work Flows

Run a workflow

post/api/v1/agentic/work-flows/run-workflow/{id}

Request

  • Base URL: https://api.voicelogica.ai
  • URL: https://api.voicelogica.ai/api/v1/agentic/work-flows/run-workflow/{id}
  • Auth: API key in header x-api-key

Headers

x-api-keystring required

Your API key for authentication. Required for all endpoints.

x-company-idstring

Optional company ID for resellers. When provided, the API request will operate on behalf of the specified subsidiary company. The API key must have access to the specified company.

Request body

workflowIdstring

Workflow ID

connectionIdstring

Connection ID

triggerType'onCallStart' | 'onCallConnect' | 'onCallEnd' | 'onCallTransfer' | 'onMissedCall' | 'onDTMFInput' | 'onKeywordDetected' | 'duringCall' | 'onEmailReceived' | 'onAPICall' | 'onContactCreated' | 'onCompanyCreated' | 'onDealCreated' | 'onTicketCreated' | 'onPropertyChange' | 'onWooCommerce' | 'onYubotoPbxChannelHangup' | 'onYubotoPbxChannelAnswer' | 'onYubotoPbxChannelCreate' | 'onCampaignLeadStatusChanged' | 'onShopifyEvent' | 'onLeadReceived'

Trigger type (includes call, messaging, API, and integration triggers)

triggerIdstring

Trigger ID

workflowVersionIdstring

Saved workflow version to run instead of the live workflow

dryRunNotificationsboolean

When true, email/SMS/Viber nodes preview resolved recipients/content without sending

Example request

{
  "workflowId": "1234567890",
  "connectionId": "1234567890",
  "payload": {
    "agent_id": "1234567890",
    "call": {
      "company_phone_number": "1234567890",
      "call_direction": "inbound",
      "phone_number": "1234567890",
      "call_id": "1234567890",
      "id": "1234567890"
    },
    "client_name": "Example Client"
  },
  "triggerType": "onAPICall",
  "triggerId": "1234567890",
  "dryRunNotifications": true
}

Response

Workflow run successfully

roomIdstring

WebSocket room ID to subscribe to for real-time updates (only present if useWebsocket is true)

Example response

{
  "roomId": "123e4567-e89b-12d3-a456-426614174000"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.