You can now subscribe to Studio Events for Executions and Steps instead of polling via the REST API. Simplify your data ingestion with Event Streams for Studio.
An Execution represents a specific person's run through a Flow. An execution is active while the user is in the Flow, and it is considered ended when they stop or are kicked out of the Flow.
HTTP requests to Studio's REST API are protected with HTTP Basic authentication. To learn more about how Twilio handles authentication, please see our security documentation. You will use your Twilio account SID as the username and your auth token as the password for HTTP Basic authentication.
When triggering flows with the API, don't forget to also configure your Twilio Phone Number with your Studio Flow. If you don't configure the phone number, users won't be able to reply to your messages or call back to your IVR.
The contact_sid property has been deprecated and will be replaced with a static placeholder value in the v1 API. Use contact_channel_address instead to uniquely track contacts. For the best experience and latest features, upgrade to the v2 API.
You can now subscribe to Studio Events for Executions and Steps instead of polling via the REST API. Simplify your data ingestion with Event Streams for Studio.
The unique string that we created to identify the Execution resource.
^FN[0-9a-fA-F]{32}$Min length: 34Max length: 34The SID of the Account that created the Execution resource.
^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34The SID of the Flow.
^FW[0-9a-fA-F]{32}$Min length: 34Max length: 34The SID of the Contact.
^FC[0-9a-fA-F]{32}$Min length: 34Max length: 34The phone number, SIP address or Client identifier that triggered the Execution. Phone numbers are in E.164 format (e.g. +16175551212). SIP addresses are formatted as [email protected]. Client identifiers are formatted client:name.
The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution.
The status of the Execution. Can be: active or ended.
activeendedThe date and time in GMT when the resource was created specified in ISO 8601 format.
The date and time in GMT when the resource was last updated specified in ISO 8601 format.
The URLs of nested resources.
POST https://studio.twilio.com/v1/Flows/{FlowSid}/ExecutionsStudio Rate Limits
Be sure to review Studio's rate limits when building your application.
The SID of the Excecution's Flow.
^FW[0-9a-fA-F]{32}$Min length: 34Max length: 34application/x-www-form-urlencodedThe Contact phone number to start a Studio Flow Execution, available as variable {{contact.channel.address}}.
The Twilio phone number to send messages or initiate calls from during the Flow's Execution. Available as variable {{flow.channel.address}}. For SMS, this can also be a Messaging Service SID.
JSON data that will be added to the Flow's context and that can be accessed as variables inside your Flow. For example, if you pass in Parameters={"name":"Zeke"}, a widget in your Flow can reference the variable {{flow.data.name}}, which returns "Zeke". Note: the JSON value must explicitly be passed as a string, not as a hash object. Depending on your particular HTTP library, you may need to add quotes or URL encode the JSON string.
1// Download the helper library from https://www.twilio.com/docs/node/install2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";34// Find your Account SID and Auth Token at twilio.com/console5// and set the environment variables. See http://twil.io/secure6const accountSid = process.env.TWILIO_ACCOUNT_SID;7const authToken = process.env.TWILIO_AUTH_TOKEN;8const client = twilio(accountSid, authToken);910async function createExecution() {11const execution = await client.studio.v112.flows("FWXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")13.executions.create({14from: "+15017122661",15to: "+15558675310",16});1718console.log(execution.sid);19}2021createExecution();
1{2"url": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",3"sid": "FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",4"account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",5"flow_sid": "FWXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",6"context": {},7"contact_sid": "FCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",8"contact_channel_address": "+18001234567",9"status": "active",10"date_created": "2015-07-30T20:00:00Z",11"date_updated": "2015-07-30T20:00:00Z",12"links": {13"steps": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps",14"execution_context": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context"15}16}
1// Download the helper library from https://www.twilio.com/docs/node/install2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";34// Find your Account SID and Auth Token at twilio.com/console5// and set the environment variables. See http://twil.io/secure6const accountSid = process.env.TWILIO_ACCOUNT_SID;7const authToken = process.env.TWILIO_AUTH_TOKEN;8const client = twilio(accountSid, authToken);910async function createExecution() {11const execution = await client.studio.v112.flows("FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")13.executions.create({14from: "+14155552344",15parameters: {16foo: "bar",17},18to: "+14155552345",19});2021console.log(execution.sid);22}2324createExecution();
1{2"url": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",3"sid": "FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",4"account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",5"flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",6"context": {},7"contact_sid": "FCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",8"contact_channel_address": "+18001234567",9"status": "active",10"date_created": "2015-07-30T20:00:00Z",11"date_updated": "2015-07-30T20:00:00Z",12"links": {13"steps": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps",14"execution_context": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context"15}16}
GET https://studio.twilio.com/v1/Flows/{FlowSid}/Executions/{Sid}The SID of the Flow with the Execution resource to fetch
^FW[0-9a-fA-F]{32}$Min length: 34Max length: 34The SID of the Execution resource to fetch.
^FN[0-9a-fA-F]{32}$Min length: 34Max length: 341// Download the helper library from https://www.twilio.com/docs/node/install2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";34// Find your Account SID and Auth Token at twilio.com/console5// and set the environment variables. See http://twil.io/secure6const accountSid = process.env.TWILIO_ACCOUNT_SID;7const authToken = process.env.TWILIO_AUTH_TOKEN;8const client = twilio(accountSid, authToken);910async function fetchExecution() {11const execution = await client.studio.v112.flows("FWXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")13.executions("FNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")14.fetch();1516console.log(execution.sid);17}1819fetchExecution();
1{2"sid": "FNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",3"account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",4"flow_sid": "FWXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",5"contact_sid": "FCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",6"contact_channel_address": "+14155555555",7"status": "ended",8"context": {},9"date_created": "2017-11-06T12:00:00Z",10"date_updated": null,11"url": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",12"links": {13"steps": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps",14"execution_context": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context"15}16}
GET https://studio.twilio.com/v1/Flows/{FlowSid}/ExecutionsExecution resources are listed in reverse chronological order (most recent is first).
The SID of the Flow with the Execution resources to read.
^FW[0-9a-fA-F]{32}$Min length: 34Max length: 34Only show Execution resources starting on or after this ISO 8601 date-time, given as YYYY-MM-DDThh:mm:ss-hh:mm.
Only show Execution resources starting before this ISO 8601 date-time, given as YYYY-MM-DDThh:mm:ss-hh:mm.
How many resources to return in each list page. The default is 50, and the maximum is 1000.
1Maximum: 1000The page token. This is provided by the API.
1// Download the helper library from https://www.twilio.com/docs/node/install2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";34// Find your Account SID and Auth Token at twilio.com/console5// and set the environment variables. See http://twil.io/secure6const accountSid = process.env.TWILIO_ACCOUNT_SID;7const authToken = process.env.TWILIO_AUTH_TOKEN;8const client = twilio(accountSid, authToken);910async function listExecution() {11const executions = await client.studio.v112.flows("FWXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")13.executions.list({ limit: 20 });1415executions.forEach((e) => console.log(e.sid));16}1718listExecution();
1{2"meta": {3"previous_page_url": null,4"next_page_url": null,5"url": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions?PageSize=50&Page=0",6"page": 0,7"first_page_url": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions?PageSize=50&Page=0",8"page_size": 50,9"key": "executions"10},11"executions": []12}
1// Download the helper library from https://www.twilio.com/docs/node/install2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";34// Find your Account SID and Auth Token at twilio.com/console5// and set the environment variables. See http://twil.io/secure6const accountSid = process.env.TWILIO_ACCOUNT_SID;7const authToken = process.env.TWILIO_AUTH_TOKEN;8const client = twilio(accountSid, authToken);910async function listExecution() {11const executions = await client.studio.v112.flows("FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")13.executions.list({14dateCreatedFrom: new Date("2019-02-17 00:00:00"),15dateCreatedTo: new Date("2019-02-18 00:00:00"),16limit: 20,17});1819executions.forEach((e) => console.log(e.sid));20}2122listExecution();
1{2"meta": {3"previous_page_url": null,4"next_page_url": null,5"url": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions?PageSize=50&Page=0",6"page": 0,7"first_page_url": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions?PageSize=50&Page=0",8"page_size": 50,9"key": "executions"10},11"executions": []12}
POST https://studio.twilio.com/v1/Flows/{FlowSid}/Executions/{Sid}An active Execution can be updated to "ended" using the REST API. Once ended, subsequent widgets in the Flow are not processed, and any new events that Studio receives for that Execution are rejected.
The SID of the Flow with the Execution resources to update.
^FW[0-9a-fA-F]{32}$Min length: 34Max length: 34The SID of the Execution resource to update.
^FN[0-9a-fA-F]{32}$Min length: 34Max length: 34application/x-www-form-urlencodedThe status of the Execution. Can only be ended.
activeended1// Download the helper library from https://www.twilio.com/docs/node/install2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";34// Find your Account SID and Auth Token at twilio.com/console5// and set the environment variables. See http://twil.io/secure6const accountSid = process.env.TWILIO_ACCOUNT_SID;7const authToken = process.env.TWILIO_AUTH_TOKEN;8const client = twilio(accountSid, authToken);910async function updateExecution() {11const execution = await client.studio.v112.flows("FWXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")13.executions("FNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")14.update({ status: "ended" });1516console.log(execution.sid);17}1819updateExecution();
1{2"url": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",3"sid": "FNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",4"account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",5"flow_sid": "FWXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",6"context": {},7"contact_sid": "FCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",8"contact_channel_address": "+14155555555",9"status": "ended",10"date_created": "2017-11-06T12:00:00Z",11"date_updated": "2017-11-06T12:00:00Z",12"links": {13"steps": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps",14"execution_context": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context"15}16}
DELETE https://studio.twilio.com/v1/Flows/{FlowSid}/Executions/{Sid}The SID of the Flow with the Execution resources to delete.
^FW[0-9a-fA-F]{32}$Min length: 34Max length: 34The SID of the Execution resource to delete.
^FN[0-9a-fA-F]{32}$Min length: 34Max length: 341// Download the helper library from https://www.twilio.com/docs/node/install2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";34// Find your Account SID and Auth Token at twilio.com/console5// and set the environment variables. See http://twil.io/secure6const accountSid = process.env.TWILIO_ACCOUNT_SID;7const authToken = process.env.TWILIO_AUTH_TOKEN;8const client = twilio(accountSid, authToken);910async function deleteExecution() {11await client.studio.v112.flows("FWXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")13.executions("FNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")14.remove();15}1617deleteExecution();