How to Create and Manage Webhooks

What is a Webhook?

Webhooks are user-defined HTTP callbacks that allow BoldDesk to send real-time data to external applications when specific events occur. They enable seamless integration with third-party APIs, automation platforms, and internal systems.

When a ticket is created in BoldDesk, the ticket data is sent to a configured URL via an HTTP POST request.

Check out this video tutorial to learn more.

How to Create a Webhook

To create a webhook, follow these steps:

1. Go to Admin → Webhooks.

2. Click Add Webhook.

   

3. Fill in the following details:

   • Name & Description: Provide a clear identifier and purpose.

   • Module & Event: Choose the module (e.g., Tickets) and the event (e.g., Ticket Created).

   • Webhook Endpoint: Enter the target URL to receive data.

   • Request Type: Select from POST, PUT, PATCH, or DELETE based on the target API.
     

     

   • Authentication (optional): Enable to verify the sender.

   • Signing (optional): Enable to verify payload integrity.

   • Condition (optional): Define conditions for triggering the webhook.

   • Payload: Select the module data to include in the webhook.

4. Click Add to save the webhook.

How to Edit a Webhook

To update the existing webhook, follow the given steps:

1. Go to Admin → Webhooks.

2. Locate the webhook in the list.

3. Click the Edit icon.

4. Update the necessary fields.

5. Click Save.

   

Deleting a webhook

If a webhook is no longer used, you can delete it from the webhook list page. To delete a webhook, follow the given steps:

1. Click Admin → Webhooks.

2. Find the webhook on the webhook list page.

3. Click the Kebab icon (⁝) and select Delete.

4. Click the Yes, Delete button in the confirmation dialog to delete the webhook.

   
   

Deactivating a webhook

If you don’t want to delete the webhook permanently or stop the webhook temporarily, you can deactivate the webhook from the active list.

To deactivate the webhook, follow the given steps:

1. Click Admin → Webhooks.

2. Select the Active tab on the webhook list page.

3. Find the webhook to deactivate.

4. Click the Kebab icon (⁝) and select Deactivate.

   

Activating a webhook

You can activate a webhook that is deactivated from the inactive list.

To activate the webhook, follow these steps:

1. Click Admin → Webhooks.

2. Select the Inactive tab on the webhook list page.

3. Find the webhook to activate.

4. Click the Kebab icon (⁝) and select Activate.

   

Frequently Asked Questions (FAQ)

Q1: What is the purpose of a webhook in BoldDesk?
To send real-time data to external systems when specific events occur.

Q2: Can I use different HTTP methods for webhooks?
Yes. You can choose from POST, PUT, PATCH, or DELETE.

Q3: What happens if a webhook fails?
Failures are logged in the Webhook Failure Logs under Audit Logs.

Q4: Can I conditionally trigger a webhook?
Yes. You can define conditions that must be met for the webhook to fire.