Webhook Payloads, Headers, and Event

Webhook modules and events

A webhook is triggered when an action is performed on a module in the BoldDesk. Each module has a unique set of events.
When creating a webhook, you should select the modules and events.
The modules and events that are supported are listed in the table below.

Webhook headers

System and custom headers are sent along with webhook data to the specified webhook endpoints.

Alternatively, when creating a webhook, you have the option to include your custom headers.

System headers

By default, the headers listed below are sent with each webhook request.

Custom headers

Custom headers are used to send additional information to the destination URL.
Follow the given steps to add a custom header:

1. Enter the key and value of the header and click Add to add it to the header record.
2. To remove the header, click the Delete.

Webhook payload

The data from the selected module are sent as a webhook payload.
Ways to send the webhook payload include:

• Default Payload
• Advanced Payload

Default Payload

This option automatically sends a default payload template to a webhook, which varies depending on the events.

You can send all of them or only the required data by selecting the following options:

• Include all fields in the payload (Optional)
  When this option is enabled, all data are sent in the payload.
• Payload (Required)
  The selected data are sent in the payload.

Advanced Payload

This option allows you to customize and configure a specific payload to a webhook endpoint.

Sample payload

{
"priorityId": 2,
"requesterEmailId": "john@example.com",
"brandId": 1,
"isVisibleInCustomerPortal": {{ticket.IsVisibleInCustomerPortal}},
"subject": {{ticket.Subject}},
"description": {{ticket.Description}},
"tag": "created-by-webhook"
}