Menu

Expand
Rate this page:

Thanks for rating this page!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

Flex Flow Resource

A Flex Flow is the logic linking a Messaging Channel, like SMS or WhatsApp, to Flex.

This page details the Flex Flow API Resource. Check out the additional documentation to learn more about working with Flex Flows.

FlexFlow properties

Resource Properties in REST API format
account_sid
sid<AC> Not PII

The SID of the Account that created the FlexFlow resource and owns this Workflow.

date_created
date_time<iso8601> Not PII

The date and time in GMT when the resource was created specified in ISO 8601 format.

date_updated
date_time<iso8601> Not PII

The date and time in GMT when the resource was last updated specified in ISO 8601 format.

sid
sid<FO> Not PII

The unique string that we created to identify the FlexFlow resource.

friendly_name

The string that you assigned to describe the resource.

chat_service_sid
sid<IS> Not PII

The SID of the chat service.

channel_type
enum:channel_type Not PII

The channel type. Can be: web, facebook, sms, whatsapp, line or custom.

contact_identity
string Not PII

The channel contact's Identity.

enabled
boolean Not PII

Whether the FlexFlow is enabled.

integration_type
enum:integration_type Not PII

The integration type. Can be: studio, external, or task.

integration
object Not PII

An object that contains specific parameters for the integration.

long_lived
boolean Not PII

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.

janitor_enabled
boolean Not PII

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.

url
url Not PII

The absolute URL of the FlexFlow resource.

Create a Flex Flow with Studio

post
https://flex-api.twilio.com/v1/FlexFlows
Parameters
Parameters in REST API format
friendly_name
Required
post string PII MTL: 30 DAYS

A descriptive string that you create to describe the FlexFlow resource.

chat_service_sid
Required
post sid<IS> Not PII

The SID of the chat service.

channel_type
Required
post ienum:channel_type Not PII

The channel type. Can be: web, facebook, sms, whatsapp, line or custom.

contact_identity
Optional
post string Not PII

The channel contact's Identity.

enabled
Optional
post boolean Not PII

Whether the new FlexFlow is enabled.

integration_type
Optional
post ienum:integration_type Not PII

The integration type. Can be: studio, external, or task.

integration.flow_sid
Optional
post sid<FW> Not PII

The SID of the Flow when integration_type is studio.

integration.url
Optional
post url Not PII

The External Webhook URL when integration_type is external.

integration.workspace_sid
Optional
post sid<WS> Not PII

The Workspace SID for a new task for Task integration_type.

integration.workflow_sid
Optional
post sid<WW> Not PII

The Workflow SID for a new task when integration_type is task.

integration.channel
Optional
post string Not PII

The task channel for a new task when integration_type is task. The default is default.

integration.timeout
Optional
post integer Not PII

The task timeout in seconds for a new task when integration_type is task. The default is 86,400 seconds (24 hours).

integration.priority
Optional
post integer Not PII

The task priority of a new task when integration_type is task. The default priority is 0.

integration.creation_on_message
Optional
post boolean Not PII

Whether to create a task when the first message arrives when integration_type is task. If false, the task is created with the channel. Note that does not apply when channel type is web. Setting the value to true for channel type web will result in misconfigured Flex Flow and no tasks will be created.

long_lived
Optional
post boolean Not PII

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.

janitor_enabled
Optional
post boolean Not PII

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.

integration.retry_count
Optional
post integer Not PII

The number of times to retry the webhook if the first attempt fails. Can be an integer between 0 and 3, inclusive, and the default is 0.

Example 1
        
        
        
        
        Example 2
              
              
              
              

              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.

                    
                    
                    
                    

                    Fetch a FlexFlow resource

                    get
                    https://flex-api.twilio.com/v1/FlexFlows/{Sid}
                    Parameters
                    Parameters in REST API format
                    sid
                    Path
                    get sid<FO> Not PII

                    The SID of the FlexFlow resource to fetch.

                    Example 1
                          
                          
                          
                          

                          Read multiple FlexFlow resources

                          get
                          https://flex-api.twilio.com/v1/FlexFlows
                          Parameters
                          Parameters in REST API format
                          friendly_name
                          Optional
                          get string PII MTL: 30 DAYS

                          The friendly_name of the FlexFlow resources to read.

                          Example 1
                                
                                
                                
                                

                                Update a FlexFlow resource

                                post
                                https://flex-api.twilio.com/v1/FlexFlows/{Sid}
                                Parameters
                                Parameters in REST API format
                                sid
                                Path
                                post sid<FO> Not PII

                                The SID of the FlexFlow resource to update.

                                friendly_name
                                Optional
                                post string PII MTL: 30 DAYS

                                A descriptive string that you create to describe the FlexFlow resource.

                                chat_service_sid
                                Optional
                                post sid<IS> Not PII

                                The SID of the chat service.

                                channel_type
                                Optional
                                post ienum:channel_type Not PII

                                The channel type. Can be: web, facebook, sms, whatsapp, line or custom.

                                contact_identity
                                Optional
                                post string Not PII

                                The channel contact's Identity.

                                enabled
                                Optional
                                post boolean Not PII

                                Whether the FlexFlow is enabled.

                                integration_type
                                Optional
                                post ienum:integration_type Not PII

                                The integration type. Can be: studio, external, or task.

                                integration.flow_sid
                                Optional
                                post sid<FW> Not PII

                                The SID of the Flow when integration_type is studio.

                                integration.url
                                Optional
                                post url Not PII

                                The External Webhook URL when integration_type is external.

                                integration.workspace_sid
                                Optional
                                post sid<WS> Not PII

                                The Workspace SID for a new task when integration_type is task.

                                integration.workflow_sid
                                Optional
                                post sid<WW> Not PII

                                The Workflow SID for a new task when integration_type is task.

                                integration.channel
                                Optional
                                post string Not PII

                                The task channel for a new task when integration_type is task. The default is default.

                                integration.timeout
                                Optional
                                post integer Not PII

                                The task timeout in seconds for a new task when integration_type is task. The default is 86,400 seconds (24 hours).

                                integration.priority
                                Optional
                                post integer Not PII

                                The task priority of a new task when integration_type is task. The default priority is 0.

                                integration.creation_on_message
                                Optional
                                post boolean Not PII

                                Whether to create a task when the first message arrives when integration_type is task. If false, the task is created with the channel. Note that does not apply when channel type is web. Setting the value to true for channel type web will result in misconfigured Flex Flow and no tasks will be created.

                                long_lived
                                Optional
                                post boolean Not PII

                                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.

                                janitor_enabled
                                Optional
                                post boolean Not PII

                                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.

                                integration.retry_count
                                Optional
                                post integer Not PII

                                The number of times to retry the webhook if the first attempt fails. Can be an integer between 0 and 3, inclusive, and the default is 0.

                                Example 1
                                      
                                      
                                      
                                      

                                      Delete a Flex Flow

                                      delete
                                      https://flex-api.twilio.com/v1/FlexFlows/{Sid}
                                      Parameters
                                      Parameters in REST API format
                                      sid
                                      Path
                                      delete sid<FO> Not PII

                                      The SID of the FlexFlow resource to delete.

                                      Example 1
                                            
                                            
                                            
                                            
                                            Rate this page:

                                            Need some help?

                                            We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the Twilio tag on Stack Overflow.