HTTP Request / API

Performs an HTTP request with a third-party app's REST API endpoint.

REST APIs are used to Push / Pull data to / from third party systems. Using the Service Call action block, you can directly integrate a third-party system's REST API in a flow.

You can integrate GET, POST or PUT type REST API through Service Call action block from the Bot Builder page.

Here are the steps that you can follow to configure the same:

1. Add the ‘Service Call’ action block.

2. Configure your API on the right panel. To configure your API on the Http Request action block, below are the fields that you would be filling values in. If you are a developer, you would feel at home here, for others, you may need to refer to the APIs documentation to find what to fill on the right panel.

   
3. Types of Methods: You will first need to select the 'Type of Method' from the drop-down list from the available options. Reply CX currently supports three types of methods, they are:

   • GET

   • POST

   • PUT

     
4. Endpoint URL: You will need to provide the absolute URL i.e., starting with HTTP or HTTPS. You can also use the variables in the URL by typing '#' as some of the APIs do not have headers and everything is mentioned in the URL itself.

   For example: https://api.weatherapi.com/v1/current.json?
   key=e943b863ebed4572b55140350200312&q=#city#city#.
   
   In the above link, #city# is the variable that has been used.

   

   1. Headers: 'Request Headers' allows you to authenticate the API based on its tokens. You can also use variables as tokens too by typing '#'. You need to ensure that you add following token in the header:

      
   2. Body: Under ‘Request Body’ you can define what information needs to be sent or retrieved by calling the API. There are two ways through which the information can be sent or retrieved:

      • Raw: It is normal JSON format in which the request needs to be passed.

        {     
                  "User_name": "Travis",
                  "City": "Denver"
        }

      • Form: Used to map the fields. You can either provide static value or map with the variables.

        The values can be mapped in following way:
         
        Key1: User_name
        Value/Variable1: Travis / #name#
         
        
        Key 2: City
        Value/Variable: Denver / #City#

1. Response: You can further store the responses received from the API into the variables which can be further used in the bot flow or bot message. ReplyCX follows the dot pattern to store the responses into the variables. Below are a few of the ways in which the path can be defined.

   Object path for storing the response into variable where list is returned
   result.data.list[0].’variable name’
   Here the ‘variable name’ is name of variable where the response will be stored.
   
   
   Object path for storing the response into variable where single value is returned
   result.data.’variable name’
   Here the ‘variable name’ is name of variable where the response will be stored.

Testing the Integration:

You can test the API within the block itself as well as define variables and store the responses in them.

1. Click on 'Test the API' button.

   
2. Provide the input in the variable (optional).

3. Click on ‘Test the API’ again to check the results.

Storing the Responses:

1. Click on 'Expand Icon' to expand the results.

2. Click on ‘+’ sign against the field to store the value into the variable.

   
3. Define the variable in 'Save the field in this variable'.