Menu

Expand
Rate this page:

Studio Flow and Widget JSON Schemas

Official JSON Schemas for Studio Flow definitions and widgets are available in the list below. Flow definitions must adhere to these schemas when creating or updating via the Flows REST API.

These schemas can be used for reference or for client-side validation in your local development environment. For sample Flow definitions to use in your applications, use the JSON snippets from Studio Flow Definition.

Loading Code Sample...
        
        

        Flow Definition Schema

        Loading Code Sample...
              
              

              Trigger Schema

              Loading Code Sample...
                    
                    

                    Add TwiML Redirect Schema

                    Loading Code Sample...
                          
                          

                          Capture Payments Schema

                          Loading Code Sample...
                                
                                

                                Connect Call To Schema

                                Loading Code Sample...
                                      
                                      

                                      Enqueue Call Schema

                                      Loading Code Sample...
                                            
                                            

                                            Fork Stream Schema

                                            Loading Code Sample...
                                                  
                                                  

                                                  Gather Input On Call Schema

                                                  Loading Code Sample...
                                                        
                                                        

                                                        Make HTTP Request Schema

                                                        Loading Code Sample...
                                                              
                                                              

                                                              Make Outgoing Call v1 Schema (Deprecated)

                                                              Loading Code Sample...
                                                                    
                                                                    

                                                                    Make Outgoing Call v2 Schema

                                                                    Loading Code Sample...
                                                                          
                                                                          

                                                                          Record Call Schema

                                                                          Loading Code Sample...
                                                                                
                                                                                

                                                                                Record Voicemail Schema

                                                                                Loading Code Sample...
                                                                                      
                                                                                      

                                                                                      Run Function Schema

                                                                                      Loading Code Sample...
                                                                                            
                                                                                            

                                                                                            Say/Play Schema

                                                                                            Loading Code Sample...
                                                                                                  
                                                                                                  

                                                                                                  Send & Wait For Reply Schema

                                                                                                  Loading Code Sample...
                                                                                                        
                                                                                                        

                                                                                                        Send Message Schema

                                                                                                        Loading Code Sample...
                                                                                                              
                                                                                                              

                                                                                                              Send to Autopilot Schema

                                                                                                              Loading Code Sample...
                                                                                                                    
                                                                                                                    

                                                                                                                    Send to Flex Schema

                                                                                                                    Loading Code Sample...
                                                                                                                          
                                                                                                                          

                                                                                                                          Set Variables Schema

                                                                                                                          Loading Code Sample...
                                                                                                                                
                                                                                                                                

                                                                                                                                Split Based On Schema

                                                                                                                                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 by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.

                                                                                                                                Loading Code Sample...
                                                                                                                                      
                                                                                                                                      
                                                                                                                                      

                                                                                                                                      Thank you for your feedback!

                                                                                                                                      Please select the reason(s) for your feedback. The additional information you provide helps us improve our documentation:

                                                                                                                                      Sending your feedback...
                                                                                                                                      🎉 Thank you for your feedback!
                                                                                                                                      Something went wrong. Please try again.

                                                                                                                                      Thanks for your feedback!

                                                                                                                                      thanks-feedback-gif