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
Try 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.
ExecutionStep properties
| Resource Properties in REST API format | |
|---|---|
sid
|
The unique string that we created to identify the ExecutionStep resource. |
account_sid
|
The SID of the Account that created the ExecutionStep resource. |
flow_sid
|
The SID of the Flow. |
execution_sid
|
The SID of the Step's Execution resource. |
name
|
The event that caused the Flow to transition to the Step. |
context
|
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
|
The Widget that preceded the Widget for the Step. |
transitioned_to
|
The Widget that will follow the Widget for the Step. |
date_created
|
The date and time in GMT when the resource was created specified in ISO 8601 format. |
date_updated
|
The date and time in GMT when the resource was last updated specified in ISO 8601 format. |
url
|
The absolute URL of the resource. |
links
|
The URLs of related resources. |
Fetch a step resource
https://studio.twilio.com/v2/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps/{Sid}
Parameters
| Parameters in REST API format | |
|---|---|
flow_sid
Path
|
The SID of the Flow with the Step to fetch. |
execution_sid
Path
|
The SID of the Execution resource with the Step to fetch. |
sid
Path
|
The SID of the ExecutionStep resource to fetch. |
Example 1
Read a list of step resources
https://studio.twilio.com/v2/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps
Step resources are listed in reverse chronological order (most recent is first).
Parameters
| Parameters in REST API format | |
|---|---|
flow_sid
Path
|
The SID of the Flow with the Steps to read. |
execution_sid
Path
|
The SID of the Execution with the Steps to read. |
Example 1
Data retention and delivery
For information on data retention in Studio, please reference the Studio User Guide. Keep in mind the following:
Step logs are best-effort delivery. This means that the network does not guarantee that this data will be delivered.
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 by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.
