If you want to dive right in, try our simple Flows API Quickstart to get a feel for fetching and updating Flows via the API and seeing how they look in the Studio Canvas in Console.
With the Studio REST API you can trigger Flows programmatically for outbound use cases, manage Flow definitions for automated deployments, and retrieve information about Executions for reporting.
Flows can respond to incoming calls and incoming messages, but you can also trigger a Studio Flow programmatically to initiate an outbound call or message. To trigger a Studio Flow for an outbound use case, use the REST API to create a new Execution. Creating a new Execution will fire the REST API trigger on your Flow and execute any connected widgets.
Common use cases for creating Executions via the REST API:
Using the Studio Canvas in Twilio Console, you can quickly build Studio Flows in a visual editing environment. With the new Studio REST API v2, you can now create, publish, and manage those same Flows programmatically without having to log in to Twilio Console.
Common use cases for managing Flows via the REST API:
Flows are defined as human-readable JSON objects and machine-validated against a set of JSON Schemas.
If you want to dive right in, try our simple Flows API Quickstart to get a feel for fetching and updating Flows via the API and seeing how they look in the Studio Canvas in Console.
The Studio REST API provides methods to fetch Execution and Step data, but polling list endpoints for this data can be tedious. Instead, we recommend you subscribe to Studio Flow events through Event Streams to push the data to your own endpoint.
The Studio v2 API mirrors the existing v1 API but provides additional endpoints and methods for managing Flows, including the ability to read, create, update and validate Flow definitions. The Flow definition itself is now standardized as a JSON schema.
Flows resource in v2 has new Create, Update and Validate endpoints and additional properties.TestUsers resource is available to manage the contact addresses that can be used to test draft revisions of a Flow.contact_sid is deprecated and will not be available in v2 Execution endpoint. Use contact_channel_address instead to uniquely track contacts.Engagements endpoints were previously deprecated and are not included in v2. Use the Executions endpoints instead.POST to Flows cannot be larger than 1 MB; thus, the Flow JSON definition itself must be less than 1 MB.The standard Twilio server-side helper libraries and the Twilio CLI can be used to access the v2 endpoints. To access the v2 endpoints via the Twilio helper libraries, use the v2 namespace when referencing the client.
Example using the Node.js helper library:
1const client = require('twilio')(accountSid, authToken);23client.studio.v2.flows('FWXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')4.fetch()5.then(flow => console.log(flow.friendlyName));
If you have already built your application on v1 and use the shortcut syntax in the helper libraries — specifically Node.js, PHP, Python, and Ruby — upgrading to the latest version will automatically update your code behind the scenes to reference the v2 API, which may be unexpected.
For example, if you currently use Node.js without the version indicator in the namespace, this will point to v2 after upgrade:
1client.studio.flows('FWXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')2.executions3.create({to: '+15558675310', from: '+15017122661'})4.then(execution => console.log(execution.sid));
To ensure your application references the correct version, add the version to the namespace:
1client.studio.v1.flows('FWXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')2.executions3.create({to: '+15558675310', from: '+15017122661'})4.then(execution => console.log(execution.sid));
And when you're ready to upgrade, update the namespace from v1 to v2:
1client.studio.v2.flows('FWXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')2.executions3.create({to: '+15558675310', from: '+15017122661'})4.then(execution => console.log(execution.sid));
| Resource | Description |
|---|---|
| Flow | Allows you to create, read and update Flows created in your account. |
| Flow Revision | Provides complete history of all changes to a Flow. |
| Flow Validate | Allows you to validate a Flow definition without creating a new revision. |
| Test User | Allows you to manage the contact addresses that can test draft versions of a Flow. |
| Executions | Mirrors the existing v1 endpoint, allowing Executions to be created on demand and to retrieve historical logs. |
| Execution Context | Mirrors the existing v1 endpoint |
| Step | Mirrors the existing v1 endpoint |
| Step Context | Mirrors the existing v1 endpoint |