External Web Call

An 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

Input Name Description
Username and Password

These fields support basic authentication in the event that it is required for access to the API endpoint.

Token-based authentications can be supported by adding a customer header to the request.

Method

Indicates the action for the URL to perform per the API configuration. These methods are supported by SmartFlows but depend upon the specific API configuration.

Note: Currently POST, GET, PATCH, DELETE, and PUT are available to support submitting information and extracting information, respectively.

Timeout

Set the timeout duration in seconds that SmartFlows should wait for the API response before failing the request.

The default is set to 10 seconds. Most requests are returned in less than a second.

A best practice is to keep this to a short time window to prevent consuming capacity unnecessarily.

URL of Service

Enter the URL of the API endpoint here.

Variables can be used inside URLs to target specific objects.

Content Type Select the format of the content being sent.

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:

Variable Name Description
EXTCALL_#.responsebody The entire response from the external API.
EXTCALL_#.statuscode The response code generated from the API (e.g., 200 for success, 400 for bad request, 404 not found).
EXTCALL_#.user_naming

User-configured response variables.

This offers more granularity and allows the user to extract a subset of the response.

For Example, to extract the value orderStatus from the API, add a response variable with that name to the External Web Call action. The query expression must be a literal match to the name sent by the API.

Example Response

Copy
[
{
“_id”: “5c86c534307bb30000jkjaa”,
“first_name”: “John”,
“last_name”: “Smith”,
“pin”: 7777,
}
]

Action Exit Ports

External Web Call has two events under the action drop-down that trigger transitions.

Action Exit Port Name Description
Success A connection was made.
Fail The URL does not successfully return or has an error.

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.

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