Introduction to webhooks

You can create webhooks in BoldSales to automatically send real‑time data to external applications whenever specific events occur.

This guide explains what a webhook is, where to access and manage your webhooks, and how to configure all webhook components, including destination URLs, so your external systems receive the exact information they need at the right time.

What is a webhook?

A webhook allows your application to automatically send real‑time data to an external service whenever a specific event occurs. Instead of repeatedly checking (polling) for updates, webhooks push information instantly to a URL you provide.

Accessing webhooks

To access and manage webhooks:

1. Go to Setup from the left sidebar menu.
2. Navigate to Automation > Webhooks. Alternatively, use the search bar in Setup and type webhooks.
   
3. This page displays a list of existing webhooks and options to create a new one.

Understanding webhook components

Webhook name

A user‑defined name to identify the webhook. Put a name that reflects the purpose of the webhook. For example, Send Lead Data to ERP.

Trigger module

The trigger module defines the area of the application where the webhook is activated.

When you select a module such as Contacts, the webhook will run when the workflow rule is triggered for a contact record.

Available modules include:

• Contacts
• Companies
• Pipelines
• Tasks
• Events
• Sales documents

Destination URL (HTTPS required)

Enter the external HTTPS endpoint where the webhook should send data. This is the URL that will receive the webhook payload.

Note: Before using the Insert field option, make sure you first enter the destination URL. Once the URL is added, you can select a field to insert. The list of available fields depends on the trigger module you choose.

Requires authentication

This is optional. Check this if the destination URL requires login details.

After checking the box, select the authentication method:

• Password – Enter the Username and Password required by the receiving system.
• API Key – Enter the API Key provided by the receiving system.

Enable payload signing

This is optional. Check it if you want to add an extra layer of security to your webhook requests.

When checked, you must enter a secret key. The system uses this key to generate an HMAC‑SHA256 signature. This signature is added to the webhook request in a header called x‑Signature.

Include additional headers

This is optional. Add any custom headers required by the receiving system.

You can define the Key and Value for each header (e.g., authentication tokens or content type).

Click Add another header to add additional headers

Content type

Selecting the content type is mandatory. Select the format in which the webhook payload should be sent. The receiving system should support the format you choose.

Available options:

• JSON
  Sends the payload in JSON format. Best for APIs and modern web services.

• XML
  Sends the payload in XML format. Used by systems that require structured XML input.

• X‑FORM‑URLENCODED
  Sends the payload as key‑value pairs encoded in the request body (similar to HTML form submissions). Useful for older APIs or services expecting form‑style data.

Choose fields for body content

The fields you can insert into the payload depend on the module selected for the webhook. Each module provides access to different types of information:

• Contacts: Fields from the Contact and the Primary Company linked to the Contact.
• Companies: Fields from the Company record.
• Pipelines: Fields from the Primary Contact, the linked Company, and the specific pipeline record.
• Tasks: Fields from the Task record.
• Events: Fields from the Event record.
• Sales documents: Fields specific to the selected document type (e.g., quote, invoice, order).

Select the fields you want the webhook to send.

When JSON is selected, you can:

• Choose fields for body content.
• Custom JSON - Create your own JSON structure or use the Insert field option to add dynamic values.
  

Webhook trigger rules

Add a workflow rule that determines when the webhook should run. If no rules are configured, the webhook will not be triggered.

Creating a webhook trigger rules

1. Click at the top right.
2. Fill out the required webhook settings.
3. Scroll to Webhook Trigger Rules and click Add Workflow Rule.
4. When adding a workflow rule, the module is preselected. Choose the trigger type and add conditions if needed.
5. Click to save the webhook.

Editing a webhook trigger rule

You can edit an existing webhook trigger rule if you need to change the trigger type or conditions.

To edit a webhook trigger rule:

1. Open the required webhook from Setup > Automation > Webhooks.
2. Scroll to the Webhook Trigger Rules section.
3. Click the action menu (three dots) next to the name of the workflow rule.
4. Click Edit next to the workflow rule you want to modify.
5. Update the name or add condition.
6. Click Save to apply the changes.

Note: Changes take effect immediately for all future trigger events.

Deleting a webhook trigger rule

You can permanently remove a webhook trigger rule if it is no longer required.

To delete a trigger rule:

1. Open the webhook configuration.
2. Scroll to the Webhook Trigger Rules section.
3. Click the action menu next to the name of the workflow rule.
4. Click next to the workflow rule you want to modify.
5. Confirm the deletion when prompted.