Urgent Notify (V5) - External Data Wizard Step

HTTP Method

Select the method required to retrieve data from your REST API; we support GET or POST.

URL

Enter the URL to access your REST API. URL must include 'http://' or 'https://' followed by domain and path. No parameters should be entered.

Headers

Add headers required by your REST API such as Authorization token, content-type, etc.

Parameters

Add parameters that are needed by your REST API. These parameters will be specific to your REST API call. You may use variables for parameter values by using '{' to display list of available variables and selecting from list. The variable will be replaced with a value when the data is retrieved.

Body

If the HTTP Method is 'POST' then the body is required. The body is a valid JSON object. Default value of {} is the minimum requirement.

You may use variables for data values (but not the data names) within the JSON object ( by using '{' to display list of available variables and selecting from list. The variable will be replaced with a value when the data is retrieved.

Valid HTTP Codes

Valid codes are a comma-separated list of statusCodes (i.e. 200, 202, 204,...) that are valid return codes for your REST API

Sample Data

When the 'GenerateSample' is clicked, the REST API will be accessed using the URL, headers, parameters and body specified. The result will be displayed in the area below the buttons.

You can expand the sample data structure and 'click to add' items to the Output List.

YOU SHOULD ONLY CLICK ON STRINGS, NUMBERS, AND BOOLEAN ITEMS TO USE IN OUTPUTS

Outputs

List of output items selected from the sample data and the value of that item. You can delete items from the list by clicking the delete button on the row. Items can only be added from the Sample Data.

Note: The sample data is not saved, however the list of output items and path to access it in JSON data is stored.

Outputs in the list are usable as variables in Notification Messages and Recipient Responses.

Support

Contact Sangoma Technical Support if you need assistance.