Step
A Step is the runtime processing of a Widget, starting when that Widget is entered. Variables get set at the end of a Step.
If you're prompting a user for a text input, when they receive the inbound SMS prompt, they are actively in a Step until they exit the Widget (send a response or timeout). If the prompt is intended to set a variable, this happens at the end.
Subscribe to Real-time Studio Events 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 .
Resource properties The unique string that we created to identify the ExecutionStep resource.
The SID of the Step's Execution resource.
The event that caused the Flow to transition to the Step.
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.
transitioned_from
type: string Not PIIThe Widget that preceded the Widget for the Step.
The Widget that will follow the Widget for the Step.
date_created
type: string<DATE TIME> Not PIIdate_updated
type: string<DATE TIME> Not PIIThe absolute URL of the resource.
The URLs of related resources.
GET https://studio.twilio.com/v1/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps/{Sid}
URI parameters Path Parameter
The SID of the Flow with the Step to fetch.
Path Parameter
The SID of the Execution resource with the Step to fetch.
Path Parameter
The SID of the ExecutionStep resource to fetch.
_12 // Download the helper library from https://www.twilio.com/docs/node/install
_12 // Find your Account SID and Auth Token at twilio.com/console
_12 // and set the environment variables. See http://twil.io/secure
_12 const accountSid = process.env.TWILIO_ACCOUNT_SID;
_12 const authToken = process.env.TWILIO_AUTH_TOKEN;
_12 const client = require('twilio')(accountSid, authToken);
_12 client.studio.v1.flows('FWXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_12 .executions('FNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_12 .steps('FTXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_12 .then(execution_step => console.log(execution_step.name));
_16 "sid": "FTXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_16 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_16 "flow_sid": "FWXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_16 "execution_sid": "FNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_16 "name": "incomingRequest",
_16 "transitioned_from": "Trigger",
_16 "transitioned_to": "Ended",
_16 "date_created": "2017-11-06T12:00:00Z",
_16 "date_updated": null,
_16 "url": "https://studio.twilio.com/v1/Flows/FWXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Executions/FNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Steps/FTXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_16 "step_context": "https://studio.twilio.com/v1/Flows/FWXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Executions/FNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Steps/FTXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Context"
GET https://studio.twilio.com/v1/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps
Step resources are listed in reverse chronological order (most recent is first).
URI parameters Path Parameter
The SID of the Flow with the Steps to read.
Path Parameter
The SID of the Execution with the Steps to read.
Query Parameter
How many resources to return in each list page. The default is 50, and the maximum is 1000.
Query Parameter
The page index. This value is simply for client state.
Query Parameter
The page token. This is provided by the API.
_12 // Download the helper library from https://www.twilio.com/docs/node/install
_12 // Find your Account SID and Auth Token at twilio.com/console
_12 // and set the environment variables. See http://twil.io/secure
_12 const accountSid = process.env.TWILIO_ACCOUNT_SID;
_12 const authToken = process.env.TWILIO_AUTH_TOKEN;
_12 const client = require('twilio')(accountSid, authToken);
_12 client.studio.v1.flows('FWXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_12 .executions('FNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_12 .then(steps => steps.forEach(s => console.log(s.sid)));
_12 "previous_page_url": "https://studio.twilio.com/v1/Flows/FWXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Executions/FNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Steps?PageSize=50&Page=0",
_12 "next_page_url": "https://studio.twilio.com/v1/Flows/FWXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Executions/FNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Steps?PageSize=50&Page=1",
_12 "url": "https://studio.twilio.com/v1/Flows/FWXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Executions/FNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Steps?PageSize=50&Page=0",
_12 "first_page_url": "https://studio.twilio.com/v1/Flows/FWXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Executions/FNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Steps?PageSize=50&Page=0",