data_map.webhooks

An array of objects that define external API calls.

data_map.webhooks

object[]required

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.

webhooks[].expressions

object

A list of expressions to be evaluated upon matching.

See expressions for details.

webhooks[].error_keys

string | string[]

A string or array of strings that represent the keys to be used for error handling.

webhooks[].url

stringrequired

The endpoint for the external service or API. Authentication can also be set in the url in the format of username:password@url.

webhooks[].foreach

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.

See foreach for details.

webhooks[].headers

object

Any necessary headers for the API call.

webhooks[].method

stringrequired

The HTTP method (GET, POST, etc.) for the API call.

webhooks[].input_args_as_params

boolean

Default: false

A boolean to determine if the input parameters should be passed as parameters.

webhooks[].params

object

An object of any necessary parameters for the API call. The key is the parameter name and the value is the parameter value.

webhooks[].required_args

string | string[]

A string or array of strings that represent the parameters that are required to make the webhook request.

output

objectrequired

Defines the response or action to be taken when the webhook is successfully triggered.

See output for details.