data_map.webhooks

An array of objects that define external API calls.

Name	Type	Default	Description
webhooksRequired	object[]	-	An array of objects that accept the webhooks Parameters.

webhooks Parameters

Processing Order

The properties are processed in the following sequence:

1. foreach
2. expressions
3. output

Only applicable when multiple of these properties are set in your configuration.

Name	Type	Defaults	Description
expressionsOptional	object	-	A list of expressions to be evaluated upon matching.
error_keysOptional	string | string[]	-	A string or array of strings that represent the keys to be used for error handling.
urlRequired	string	-	The endpoint for the external service or API. Authentication can also be set in the url in the format of username:password@url.
foreachOptional	object	-	Iterates over an array of objects and processes an output based on each element in the array. Works similarly to JavaScript's forEach method. This accepts the foreach properties
headersOptional	object	-	Any necessary headers for the API call.
methodRequired	string	-	The HTTP method (GET, POST, etc.) for the API call.
input_args_as_params Optional	boolean	false	A boolean to determine if the input parameters should be passed as parameters.
paramsOptional	object	-	An object of any necessary parameters for the API call. The key is the parameter name and the value is the parameter value.
required_argsOptional	string | string[]	-	A string or array of strings that represent the parameters that are required to make the webhook request.
outputRequired	object	-	Defines the response or action to be taken when the webhook is successfully triggered.