The inbound API trigger is a powerful SmartFlows action. It can:
- trigger a flow from any event that can send a POST request over a REST API.
- use parameters in the request as variables to customize content or logic.
A flow with an inbound API allows you to trigger a flow by sending a POST request.
- To trigger a SmartFlow via the REST API, make an HTTP POST request to: https://smart-flows.intelepeer.com/v2/api/apitriggers
A unique identifier for a SmartFlow found in the flow metadata section of SmartFlows.
Select the flow title for the flow Id.
An e164 format number used as the destination number in outbound communications in your flow.
An e164 format number used as the source number (e.g. caller ID) in outbound communications in your flow.
|other||string||Other parameters can be passed into the request using a “$” format. When the parameter is referenced in the flow (i.e. $accountBalance), it will be substituted for the value that was sent in the request.|
Example of parameters used in a flow
APIs in SmartFlows follow the standard response code format.
|403||Forbidden (or unauthorized)|