Black Friday Deal—Save up to 40% on an unlimited agents plan at $75.  

How to Create and Manage Webhooks

Updated on : September 16, 2022

What is a webhook?

Webhooks are user-defined HTTP callbacks that deliver real-time data to other applications when a specific event occurs in the BoldDesk. So that integration of various applications or third-party APIs with BoldDesk can be performed easily.

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

Creating webhook

To create a webhook, follow the given steps:

  1. Click Admin menu > Webhooks.
  2. Select Add Webhook on the webhook list page.
Add Webhook Option
Add Webhook Option
  • Provide the webhook details on the Add Webhook page.
    • Provide a suitable name for webhook and descriptions.
    • Select module and event to trigger the webhook.
    • Enter the webhook endpoints where the webhook data will be received.
    • Enable authentication to verify the webhook sent by the BoldDesk. This is optional.
    • Enable singing to verify the integrity of the payload at the receiver end. This is optional.
    • Condition (optional): You can configure the webhook rule only in the ticket module. Webhooks are activated when certain conditions are met.
    • Select the payload of a module to send in webhook data.
    1. Click the Add button.
    Add Option
    Add Option

     

    Editing webhook

    To update the existing webhook, follow the given steps:

    1. Click Admin menu > Webhooks.
    2. Find the webhook on the webhook list page.
    3. 3Click the Editicon to open the Edit Webhook
    4. Modify the webhook details on the Edit Webhook page.
    5. Click the Save button.
    Edit Icon
    Edit Icon

     

    Deleting webhook

    If 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 menu > 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.
    Delete Option
    Delete Option
    Yes, Delete Option
    Yes, Delete Option

     

    Deactivating webhook

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

    To deactivate the webhook, follow the given steps:

    1. Click Admin menu > 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.
    Deactivate Option
    Deactivate Option

     

    Activating webhook

    You can activate the webhook which is deactivated from the inactive list.

    To activate the webhook, follow the given steps:

    1. Click Admin menu > 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.
    Activate Option
    Activate Option

    Was this article helpful?

      Live Chat Icon