simple support ticket system

Webhook Payloads, Headers, and Event

Updated on : April 12, 2022

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 module and events.

The modules and events that are supported are listed in the following table.

ModulesEventsTriggered when
TicketCreatedA new ticket is created.
Property Updated1.     Any fields can be changed in the existing ticket.

2.     A ticket is marked as spam.

3.     A ticket is removed from spam.

4.     A ticket is deleted softly.

5.     A ticket is restored.

Reply CreatedA new reply is created.
Notes CreatedA new note is added.
Permanently DeletedA ticket is deleted permanently.
Satisfication FeedbackA feedback is added
ContactCreatedA new contact is created.
Updated1.     Any fields can be changed in the existing contact.

2.     A contact is blocked.

3.     A contact is unblocked.

4.     A contact is deleted softly.

5.     A contact is restored.

Permanently DeletedA contact is deleted permanently.
Contact GroupCreatedA new contact group is created.
UpdatedAny fields can be changed in the existing contact group.
DeletedA contact group is deleted.
WorklogCreatedA new worklog is created.
UpdatedAny fields can be changed in the existing worklog.
DeletedA worklog is deleted.

Webhook headers

System and custom headers are sent along with webhook data to the specified webhook endpoints. When creating a webhook, you can include your own custom headers.

System headers

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

Header KeysHeader Values
Host<webhook-endpoint>
AcceptEncodinggzip;q=1.0,deflate;q=0.6,identity;q=0.3
Accept-Charsetutf-8, iso-8859-1; q=0.5, *; q=0.1
Content-Typeapplication/json; charset=utf-8
User-AgentBoldDesk
AuthorizationBasic cUFEU0ZHSEpLSg==
x-signaturev7czZPsztnM910sLP5yT6OO+mVEpVktBE5zLdzkZ+rU=
Event-Type<event-name>
Event-Time05/17/2021 11:30:37

 

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 Addto add it in the header record.
  2. To remove the header, click the Delete.

Webhook payload

The data from the selected module (Ticket) will be sent as a payload; you can send all of them or only the required data by selecting the following options.

Include all fields in payload (Optional):

When this option is enabled, all data will be sent in the payload.

Payload (Required):

The selected data will only be sent in the payload.

Was this article helpful?

    Live Chat Icon