Webhook Options

The webhook payload can be customized to include more information about the webhook request.

URL Query Parameters

Query parameters can be added to the webhook url to include more information. The query parameters can be used in two ways:

1. By default, the query parameters are sent through to the OttoReciever script as the script parameter. You can retrieve the query parameters in the script using a Get(ScriptParameter) function.

2. You can optionally include the query parameters in the webhook payload by including the "includeQuery" query parameter in the webhook url. This will include the query parameters in the webhook payload at the "request-query" key as follows:

{
  "request-query": {
    "query-parameter-name": "query-parameter-value"
  },
  "rest-of-payload":{
    ...
  }
}

3. Query paramters are included in the webhook payload by default when using a GET request to send the webhook.

Request Headers

You can optionally include the headers in the webhook payload by including the "includeHeaders" query parameter in the webhook url. This will include the headers in the webhook payload at the "request-headers" key as follows:

{
  "request-headers": {
    "header-name": "header-value"
  },
  "rest-of-payload":{
    ...
  }
}