External Web Call

 
External Web Call sends a call to external systems to send and receive information. An HTTP request allows you to interact with applications and code outside of SmartFlows.
 
SmartFlows encrypts the External Web Call configuration at rest for additional security.

Inputs 

Headers

Use HTTP headers to pass additional information to the API endpoint with the request. Some things to know:

  • Use them to add metadata to the request.
  • The accepted headers are based on what is configured in the API endpoint and should be present in the API documentation.
  • Authorization/key.
 
Basic Auth

Example of what configurations would look like to extract

certain data into variables 

Response Variables

This actions takes the response from the API call and extracts JSON/XML response variables. This variable will appear in the Available Variables section of the action configuration panel in subsequent actions. There, it can be used in messages, text-to-speech, analytics, and other web calls.

 

There are different types of variables that are created in the External Web Call action. They are: 

[

   {

        “_id”: “5c86c534307bb30000jkjaa”,

       “first_name”: “John”,

        “last_name”: “Smith”,

        “pin”: 7777,

    }

]

Action Exit Ports

External Web Call has two events under the action dropdown that trigger transitions.

Test HTTP Request

Once you have entered all of your desired web call configurations, you can test your request right in SmartFlows and preview the response using the Test HTTP Request button. Here’s how it looks with an example configuration for a flow that creates a Trello card when a text message is received.

SmartFlows will then make an API call to your service and display the response in a window.

This is an example of Trello’s response when the request is successful:

This is an example of Trello’s response if the wrong token is sent:

This feature will help you debug your API configuration and get your integrations up and running faster.