Execute and monitor workflows programmatically to automate business processes, trigger notifications, route interactions, and integrate with external systems.
Endpoints
Start a Workflow Session
POST /workflows/sessions
Initiates a new workflow execution with custom variables and parameters.
Query Workflow Session Status
GET /workflows/sessions/{sessionId}
Retrieves the current status and output variables of a workflow session.
Getting Started
Find Your Customer Subdomain
Your subdomain is found in your Infinity portal URL and is required for all API calls.
Example: If your portal URL is:
https://core.avaya1234.ec.avayacloud.com/app/core-config-ui/
Your subdomain is: avaya1234
All API requests use this format:
https://core.{customer-subdomain}.ec.avayacloud.com/api/workflow/v1/...
Authentication
All endpoints require Bearer token authentication. Generate your access token using the Access Token API.
Working with Variables
Variables passed in the variables object are accessible in your workflow using double-brace syntax:
{
"variables": {
"customer_name": "John Smith",
"order_id": "ORD-2024-1984"
}
}
Access in workflow: {{customer_name}} → "John Smith"
Common Integration Patterns
Fire and Forget - Start a workflow without waiting for completion, ideal for background processing.
Start and Poll - Start a workflow and poll the status endpoint until completion to retrieve results.
Webhook Callback - Configure your workflow to call a webhook when complete, ideal for long-running processes.