Flows API

Overview

When the Flows API is triggered, it starts an interaction that executes the published version of a given Studio flow.

📘

Use Case

As a real life example, consider the case where a courier, delivering a package, uses an app to manage the delivery. The courier then clicks a button on the app that triggers an API flow. This flow will trigger an interaction with the person waiting for the package, for instance, sending an SMS and agentless voice call saying: your courier will be in the delivery location with your package in 10 minutes.

👍

Access and Registration

Authentication

Usage

Starting an interaction that executes the published version of the flow.

📘

Only flows with the API request trigger type can be triggered this way.

👍

API Availability

The Flows API has been in General Availability since April 2022.

📘

Supported Regions and Base URLs

Troubleshooting

If you have any questions regarding the usage of this API, or if you’re having any technical issues, please open a ticket using this form.