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?

REST API v2

BETA

This Twilio product is currently available as a beta release. Some features are not yet implemented and others may be changed before the product is declared as Generally Available. Beta products are not covered by a Twilio SLA. Learn more about beta product support.

Introduction

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.

Triggering Flows Programmatically

Flows can respond to incoming calls and incoming messages, but can 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:

  • Initiating appointment reminders on a schedule
  • Notifying customers of an order delivery
  • Kicking off a survey for customer service feedback
  • Alerting workers of new task assignments

Flow Publishing

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:

  • Store Flows in your own version control
  • Integrate into CI/CD pipeline to automate Studio deployments
  • Programmatically move Flows between accounts or subaccounts
  • Swap Flow variables for use in different environments
  • Expose editability to end users without having to grant them access to Console

Flows are defined as human-readable JSON objects and machine-validated against a set of JSON Schemas.

Try the Flows API Quickstart

Get Started Now

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.

Differences Between v1 and v2

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.
  • The underlying JSON definition of a Flow is exposed as a public JSON Schema instead of an internal representation.
  • Creating an Execution via the REST API for a Contact that is already in an active Execution will now fail with a 409 Conflict and will reference the conflicting Execution, which can then be ended via the API, if desired. In v1, there was no indication that an Execution was already active for that Contact.
  • TestUsers resource is available to manage the contact addreses 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.

Limitations

  • Request body when sending POST to Flows cannot be larger than 1 MB; thus, the Flow JSON definition itself must be less than 1 MB.

Helper Libraries

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:

const client = require('twilio')(accountSid, authToken);

client.studio.v2.flows('FWXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
                .fetch()
                .then(flow => console.log(flow.friendlyName));

A note about upgrading the helper library

If you have already built your application on v1 and use the shortcut syntax in the helper libraries -- sepcifically 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 unexepcted.

For example, if you currently use Node.js without the version indicator in the namespace, this will point to v2 after upgrade:

client.studio.flows('FWXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
             .executions
             .create({to: '+15558675310', from: '+15017122661'})
             .then(execution => console.log(execution.sid));

To ensure your application references the correct version, add the version to the namespace:

client.studio.v1.flows('FWXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
             .executions
             .create({to: '+15558675310', from: '+15017122661'})
             .then(execution => console.log(execution.sid));

And when you're ready to upgrade, update the namespace from v1 to v2:

client.studio.v2.flows('FWXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
             .executions
             .create({to: '+15558675310', from: '+15017122661'})
             .then(execution => console.log(execution.sid));

Studio REST API v2 Resources

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
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.