Dynamic API Workflows
Was this helpful?
Was this helpful?
Dynamic API workflow is a custom Chat Flow channel. It gets triggered by an incoming payload and lets you initiate engagement with your customers by sending a pre-approved WhatsApp template (using the node), prompting them to act and trigger a standard workflow.
Note that a Dynamic API workflow has no access to user facing nodes because it is an API builder.
How to set up a Dynamic API Workflow:
Set up the routing.
Before a route for a Dynamic API can be added it needs to be on-boarded for the entity. To activate a Dynamic API channel, you will need to with our Support Team.
Once the Dynamic API channel is added to the entity a new channel tab will appear under Chat Flow Routing.
Select Routing from the panel on the left.
Configure the relevant fields. You are presented with several options to customize the endpoint.
HTTP METHOD - Chat Flow supports the following methods:
GET
POST
DELETE
PUT
b. Allowed I.P Address Sources - This is a ';' delimited list of IP addresses that should be allowed to call your Dynamic API, e.g. 10.0.0.1;10.0.0.2.
If you want to allow any IP address access you can use 0.0.0.0/0 for IPv4 and ::/0 for IPv6 e.g. 0.0.0.0/0;::/0 to match any IPv4 and IPv6 address.
c. Asynchronous toggle.
This is set to Synchronous by default. To add an asynchronous route/request, enable the toggle. Note that for asynchronous requests there is no feedback on the response, only acknowledgement that the request was received and processed.
Select a flow and step. Save the route.
Once the route is saved, Chat Flow will generate a unique URL for your route. A unique API token will also be generated.
Build the workflow
Select Dynamic API flow under Flows from the menu on the left. A Start node and arrow will automatically appear on your canvas as the starting point for your flow.
Build out your workflow. You can select from different Action nodes from the panel on the right onto the dotted placeholder node. You can also click on the + in the placeholder node to bring up a node menu.
Repeat this process as required to build out your workflow. Remember to save your changes to each node.
There is a special end node to end the flow session. When you are at the end of your workflow, add the API end node.
Note that there is no flow preview for Dynamic API workflow. You can use an API test tool to preview/test your Dynamic API workflow.
Select a on the canvas to configure/edit it in a panel on the right.
