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

Pilot

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


Learn more about how Twilio supports products that are not yet GA.

Pilot

Studio v2 REST API is currently in pilot and available by invitation only. To receive an invite, contact Twilio Support.

Introduction

Using the Studio Canvas in Twilio Console, you can quickly build Studio Flows in a visual editing environment. With the new Studio REST API, you can now create, publish, and manage those same Flows programmatically without having to log in to Twilio Console.

Common Use Cases for the Flows 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.
  • 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 During Pilot

  • Flow Import/Export JSON feature within the Studio Console UI is not compatible with the Flows API JSON. Specifically...
    • JSON definitions fetched from the API cannot be imported via the Console UI import feature.
    • JSON definitions exported from the Console UI export feature cannot be used as the Definition in the POST to the Flows API.
  • 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 can be used to access the v2 endpoints as of the January 8, 2020 release. 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));

Studio v2 API Resources

All v2 endpoints are available during the pilot.

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.