External Web Call sends and receives information through an HTTP request. An HTTP request allows you to interact with applications and code outside of SmartFlows.
The external web call has two events under the action dropdown that trigger transitions:
A connection was made.
The URL does not successfully return or has an error.
Once the external web call returns a valid JSON object, select your data and create your variable.
Note: This is the response someone might expect if they used dot notation (i.e. array.first_name) to access the contents of an item in an array.
Headers:Use HTTP headers to pass additional information to the API endpoint along with the request.
Username and Password: These fields support basic authentication in the event that it is required for access to the API endpoint.
Method: Indicate 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, and PUT are available to support submitting information and extracting information, respectively. More methods will be added soon.
Timeout: Set the timeout duration in seconds that SmartFlows should wait for the API response before failing the request.
URL of Service: Enter the URL of the API endpoint here.
Response Variables: Extract JSON/XML responses into named variables.
This variable also appears 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.
Variables: The External Web Call action creates several variables.