HTTP Request steps in Flow Builder
- SUPPORT
In Flow Builder, HTTP Request steps are vital. They enable communication with external systems via the HTTP protocol. Users can send requests to endpoints, like getting data from a web API or triggering actions on a server. By configuring request methods, headers, and payload, these steps enhance automation and data exchange in the system.
In this guide, you'll learn how to use the HTTP Request step in Flow Builder.
If you possess basic knowledge of computer programming, then you will be able to understand and configure it promptly. Otherwise, you may need to seek advice from a professional.
Get set up
Before you start to use the HTTP Request step, you'll need to choose a flow to use the step in. For this guide, we'll be working with a basic flow that end-users can communicate with to check the status of their ticket. The flow looks like this (Use WhatsApp channel):
WhatsApp Channel Flow - The flow receives a message from an end-user via WhatsApp channel account. The message contain the Ticket ID.
Get Status from 3rd Ticket system - Fetch Ticket status from 3rd Ticket system using HTTP Request step.
Response to end-user - Response of the ticket's status to end-user.
Use the HTTP Request step
Once you have your flow set up, it's time to add the HTTP Request step.
Navigate to your flow in Flow Builder.
Underneath the Send WhatsApp message step, add the HTTP Request step by dragging and dropping from the menu on the left.
Open the HTTP Request step settings and navigate to the URL field. Enter the URL of the system from which you want to fetch the variable.
GET Method
Now, you can choose to use the GET method as follows, or skip ahead to use the POST method.
Use the Method drop-down menu to select the GET method
Input the 3rd system API URL. The URL can contain the variables that were collected from the previous step.
If the system requires authentication, you can select the already-added authentication information here. The addition of the authentication information can be accomplished by “Click here”.
If the system requires certain special HTTP headers, then the custom headers can be activated for customized configurations. Variables can also be utilized for the settings here.
After completed HTTP request from 3rd system, you can parse the variables from the response data, then set the variables to the selected system variable.
Here is some variables example:
Variables | DESC |
|---|---|
name | The first-level JSON data element. |
contact.name | The second-level JSON data element. |
contact[0] | The first element of the 'contact' array. |
contact[0].name | It would retrieve the name of the first person in that array. |
Then you can set the HTTP response code process branch. For example, when the 3rd system responds with 200, that means the operation is successful, and then you can proceed with the success flow next.
You can test your HTTP Request setting By click Test your configuration.
POST Method
The POST request configuration is almost the same as that of the GET request. The only difference is that the POST request can carry a request body:
A POST request always needs a payload, and the payload format we support is the JSON format.
The JSON data is what the 3rd system needs, and it will perform a basic format check.
The JSON data can carry the CX system variables or the variables that were collected from the previous step.
If you set the CX variables, there is no need to enclose them in double quotes. It will handle the situation on its own.