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 EventsYou 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.
Property nameTypePIIDescription
The unique string that we created to identify the ExecutionStep resource.
Pattern: ^FT[0-9a-fA-F]{32}$Min length: 34Max length: 34
The SID of the Account that created the ExecutionStep resource.
Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34
The SID of the Flow.
Pattern: ^FW[0-9a-fA-F]{32}$Min length: 34Max length: 34
The SID of the Step's Execution resource.
Pattern: ^FN[0-9a-fA-F]{32}$Min length: 34Max length: 34
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.
The Widget that preceded the Widget for the Step.
The Widget that will follow the Widget for the Step.
date_createdstring<date-time>
date_updatedstring<date-time>
The absolute URL of the resource.
The URLs of related resources.
GET https://studio.twilio.com/v2/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps/{Sid}
Property nameTypeRequiredPIIDescription
The SID of the Flow with the Step to fetch.
Pattern: ^FW[0-9a-fA-F]{32}$Min length: 34Max length: 34
ExecutionSidSID<FN>required The SID of the Execution resource with the Step to fetch.
Pattern: ^FN[0-9a-fA-F]{32}$Min length: 34Max length: 34
The SID of the ExecutionStep resource to fetch.
Pattern: ^FT[0-9a-fA-F]{32}$Min length: 34Max length: 34
_20// Download the helper library from https://www.twilio.com/docs/node/install
_20const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_20// Find your Account SID and Auth Token at twilio.com/console
_20// and set the environment variables. See http://twil.io/secure
_20const accountSid = process.env.TWILIO_ACCOUNT_SID;
_20const authToken = process.env.TWILIO_AUTH_TOKEN;
_20const client = twilio(accountSid, authToken);
_20async function fetchExecutionStep() {
_20 const step = await client.studio.v2
_20 .flows("FWXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
_20 .executions("FNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
_20 .steps("FTXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
_20 console.log(step.sid);
_17 "sid": "FTXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_17 "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_17 "flow_sid": "FWXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_17 "execution_sid": "FNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_17 "parent_step_sid": null,
_17 "name": "incomingRequest",
_17 "transitioned_from": "Trigger",
_17 "transitioned_to": "Ended",
_17 "date_created": "2017-11-06T12:00:00Z",
_17 "date_updated": null,
_17 "url": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps/FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_17 "step_context": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps/FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context"
GET https://studio.twilio.com/v2/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps
Step resources are listed in reverse chronological order (most recent is first).
Property nameTypeRequiredPIIDescription
The SID of the Flow with the Steps to read.
Pattern: ^FW[0-9a-fA-F]{32}$Min length: 34Max length: 34
ExecutionSidSID<FN>required The SID of the Execution with the Steps to read.
Pattern: ^FN[0-9a-fA-F]{32}$Min length: 34Max length: 34
Property nameTypeRequiredPIIDescription
How many resources to return in each list page. The default is 50, and the maximum is 1000.
Minimum: 1Maximum: 1000
The page index. This value is simply for client state.
Minimum: 0
The page token. This is provided by the API.
_19// Download the helper library from https://www.twilio.com/docs/node/install
_19const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_19// Find your Account SID and Auth Token at twilio.com/console
_19// and set the environment variables. See http://twil.io/secure
_19const accountSid = process.env.TWILIO_ACCOUNT_SID;
_19const authToken = process.env.TWILIO_AUTH_TOKEN;
_19const client = twilio(accountSid, authToken);
_19async function listExecutionStep() {
_19 const steps = await client.studio.v2
_19 .flows("FWXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
_19 .executions("FNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
_19 .steps.list({ limit: 20 });
_19 steps.forEach((s) => console.log(s.sid));
_12 "previous_page_url": null,
_12 "next_page_url": null,
_12 "url": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps?PageSize=50&Page=0",
_12 "first_page_url": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps?PageSize=50&Page=0",
For information on data retention in Studio, please reference the Studio User Guide. Keep in mind the following:
Warning
Step logs are best-effort delivery. This means that the network does not guarantee that this data will be delivered.