This guide is for Flex UI 1.x.x and channels that use Programmable Chat and Proxy. If you are using Flex UI 2.x.x or you are starting out, we recommend that you build with Flex Conversations.
A Flex Flow is the logic linking a contact identity (e.g. SMS-enabled phone number or WhatsApp number) to Flex.
This page details the Flex Flow API Resource. Check out the additional documentation to learn more about working with Flex Flows.
The SID of the Account that created the Flex Flow resource and owns this Workflow.
^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34The date and time in GMT when the resource was created specified in ISO 8601 format.
The date and time in GMT when the resource was last updated specified in ISO 8601 format.
The unique string that we created to identify the Flex Flow resource.
^FO[0-9a-fA-F]{32}$Min length: 34Max length: 34The SID of the chat service.
^IS[0-9a-fA-F]{32}$Min length: 34Max length: 34The channel type. One of web, facebook, sms, whatsapp, line or custom. By default, Studio’s Send to Flex widget passes it on to the Task attributes for Tasks created based on this Flex Flow. The Task attributes will be used by the Flex UI to render the respective Task as appropriate (applying channel-specific design and length limits). If channelType is facebook, whatsapp or line, the Send to Flex widget should set the Task Channel to Programmable Chat.
websmsfacebookwhatsapplinecustomThe software that will handle inbound messages. Integration Type can be: studio, external, or task.
studioexternaltaskWhen enabled, Flex will keep the chat channel active so that it may be used for subsequent interactions with a contact identity. Defaults to false.
When enabled, the Messaging Channel Janitor will remove active Proxy sessions if the associated Task is deleted outside of the Flex UI. Defaults to false.
The absolute URL of the Flex Flow resource.
POST https://flex.twilio.com/v1/FlexFlowsA descriptive string that you create to describe the Flex Flow resource.
The SID of the chat service.
^IS[0-9a-fA-F]{32}$Min length: 34Max length: 34The channel type. One of web, facebook, sms, whatsapp, line or custom. By default, Studio’s Send to Flex widget passes it on to the Task attributes for Tasks created based on this Flex Flow. The Task attributes will be used by the Flex UI to render the respective Task as appropriate (applying channel-specific design and length limits). If channelType is facebook, whatsapp or line, the Send to Flex widget should set the Task Channel to Programmable Chat.
websmsfacebookwhatsapplinecustomThe software that will handle inbound messages. Integration Type can be: studio, external, or task.
studioexternaltaskThe SID of the Studio Flow. Required when integrationType is studio.
^FW[0-9a-fA-F]{32}$Min length: 34Max length: 34The URL of the external webhook. Required when integrationType is external.
The Workspace SID for a new Task. Required when integrationType is task.
^WS[0-9a-fA-F]{32}$Min length: 34Max length: 34The Workflow SID for a new Task. Required when integrationType is task.
^WW[0-9a-fA-F]{32}$Min length: 34Max length: 34The Task Channel SID (TCXXXX) or unique name (e.g., sms) to use for the Task that will be created. Applicable and required when integrationType is task. The default value is default.
The Task timeout in seconds for a new Task. Default is 86,400 seconds (24 hours). Optional when integrationType is task, not applicable otherwise.
The Task priority of a new Task. The default priority is 0. Optional when integrationType is task, not applicable otherwise.
In the context of outbound messaging, defines whether to create a Task immediately (and therefore reserve the conversation to current agent), or delay Task creation until the customer sends the first response. Set to false to create immediately, true to delay Task creation. This setting is only applicable for outbound messaging.
When enabled, Flex will keep the chat channel active so that it may be used for subsequent interactions with a contact identity. Defaults to false.
When enabled, the Messaging Channel Janitor will remove active Proxy sessions if the associated Task is deleted outside of the Flex UI. Defaults to false.
The number of times to retry the Studio Flow or webhook in case of failure. Takes integer values from 0 to 3 with the default being 3. Optional when integrationType is studio or external, not applicable otherwise.
The Studio Usage Guide is a helpful introduction to Studio Flows and the general idea of how Studio works. If you're looking for a simple way to power your Flex Flow, an underlying Studio Flow might be the right way to go!
When you receive an inbound message, the Flex Flow will make a POST request containing the message body and some metadata to your chosen webhook.
GET https://flex.twilio.com/v1/FlexFlows/{Sid}The SID of the Flex Flow resource to fetch.
^FO[0-9a-fA-F]{32}$Min length: 34Max length: 34GET https://flex.twilio.com/v1/FlexFlowsHow many resources to return in each list page. The default is 50, and the maximum is 1000.
1Maximum: 1000The page token. This is provided by the API.
POST https://flex.twilio.com/v1/FlexFlows/{Sid}The SID of the Flex Flow resource to update.
^FO[0-9a-fA-F]{32}$Min length: 34Max length: 34A descriptive string that you create to describe the Flex Flow resource.
The SID of the chat service.
^IS[0-9a-fA-F]{32}$Min length: 34Max length: 34The channel type. One of web, facebook, sms, whatsapp, line or custom. By default, Studio’s Send to Flex widget passes it on to the Task attributes for Tasks created based on this Flex Flow. The Task attributes will be used by the Flex UI to render the respective Task as appropriate (applying channel-specific design and length limits). If channelType is facebook, whatsapp or line, the Send to Flex widget should set the Task Channel to Programmable Chat.
websmsfacebookwhatsapplinecustomThe software that will handle inbound messages. Integration Type can be: studio, external, or task.
studioexternaltaskThe SID of the Studio Flow. Required when integrationType is studio.
^FW[0-9a-fA-F]{32}$Min length: 34Max length: 34The URL of the external webhook. Required when integrationType is external.
The Workspace SID for a new Task. Required when integrationType is task.
^WS[0-9a-fA-F]{32}$Min length: 34Max length: 34The Workflow SID for a new Task. Required when integrationType is task.
^WW[0-9a-fA-F]{32}$Min length: 34Max length: 34The Task Channel SID (TCXXXX) or unique name (e.g., sms) to use for the Task that will be created. Applicable and required when integrationType is task. The default value is default.
The Task timeout in seconds for a new Task. Default is 86,400 seconds (24 hours). Optional when integrationType is task, not applicable otherwise.
The Task priority of a new Task. The default priority is 0. Optional when integrationType is task, not applicable otherwise.
In the context of outbound messaging, defines whether to create a Task immediately (and therefore reserve the conversation to current agent), or delay Task creation until the customer sends the first response. Set to false to create immediately, true to delay Task creation. This setting is only applicable for outbound messaging.
When enabled, Flex will keep the chat channel active so that it may be used for subsequent interactions with a contact identity. Defaults to false.
When enabled, the Messaging Channel Janitor will remove active Proxy sessions if the associated Task is deleted outside of the Flex UI. Defaults to false.
The number of times to retry the Studio Flow or webhook in case of failure. Takes integer values from 0 to 3 with the default being 3. Optional when integrationType is studio or external, not applicable otherwise.
DELETE https://flex.twilio.com/v1/FlexFlows/{Sid}The SID of the Flex Flow resource to delete.
^FO[0-9a-fA-F]{32}$Min length: 34Max length: 34