Start a new workflow session

Overview

This API allows you to execute workflows programmatically to automate business processes, trigger notifications, route interactions, and integrate with external systems.

Finding Your Customer Subdomain

Your subdomain is found in your Infinity portal URL.

Example: If your portal URL is:

https://core.avaya1234.ec.avayacloud.com/app/core-config-ui/

Your subdomain would be: avaya1234

To use this API:

1. Find your subdomain from your Infinity portal URL (as shown above)
2. Get your Bearer token by following the Access Token API guide
3. In the API explorer on the right:
   • Click on {customer-subdomain} in the URL field and replace it with your actual subdomain
   • Paste your Bearer token in the Credentials section
   • Fill out the Body Parameters to customize the request for your use case

The full endpoint URL structure:

POST https://core.{customer-subdomain}.ec.avayacloud.com/api/workflow/v1/workflows/sessions

Important Notes on Fields

Field Processing:

• Only fields in the variables object are accessible in workflows via {{variables.key}}
• Other optional fields (source) are processed by the system for routing and context
• These structured fields are NOT available as workflow variables
• Unrecognized fields automatically get added to the variables object

Working with Variables

Variables passed in the variables object are accessible in your workflow modules:

Access in Workflow:

{{customer_name}}  → "John Smith"
{{order_id}}       → "TEST-1984-001"
{{amount}}         → "499.99"

Common Use Cases:

• Send data to external systems via webhook modules
• Make routing decisions based on variable values (amount, status, priority)
• Update interaction records with custom data
• Process and transform business data

Additional Information

• Session begins executing immediately upon creation
• Authentication is required for all workflow executions
• This endpoint implements rate limiting and DOS protection