A webhook is a type of integration that sends information to another application when a certain action occurs in Lead Docket. When webhooks are enabled in Lead Docket, Admin users can add, edit, and delete webhooks in Manage > Webhook Rules.
To use webhooks, an Admin user must first enable webhooks in Lead Docket. If webhooks are already enabled for your organization, skip to Webhook Rules Section.
Navigate to Manage > Settings. In the settings menu bar, select Integrations.
Select Webhooks to expand the section. Click the box below Enable Webhooks, and select “Yes” from the dropdown.
At the bottom of the page, click Save. Webhooks are now enabled for your organization.
Webhook Rules Section
In the Webhook Rules section, you can add new webhooks and manage existing webhooks.
In the left-hand menu, click Manage, and select Webhook Rules from the dropdown.
The list of existing webhook rules appears. The columns display the following information for each webhook:
- Status - Whether or not the webhook is enabled. If enabled, a check mark appears. If disabled, a circle-backslash icon appears
- Title - The title of the webhook
- Trigger - The chosen action in Lead Docket that triggers the webhook
- URL - The webhook URL provided by your third party integration platform. Hover over the question mark icon to view a URL
Click the column headers to sort the list as desired. You can also click Excel to download a spreadsheet of the list, or filter the list by entering a term in the Filter: box.
At the bottom right of the list, your organization’s webhook authentication key appears. Learn more about webhook verification.
In the top right of the Webhook Rules section, select Create New to open the Add Webhook Rule form.
In the Description section, click the box under Title and enter the desired title of your webhook. Click the box under Enabled and select whether you want the webhook to be enabled initially.
In the URL section, click the box and paste the webhook URL provided by your third party integration platform (Zapier, Automate.io, for example).
In the Trigger section, click the box to open the dropdown, and choose the action within Lead Docket that you want to trigger the webhook.
If the trigger you select is Lead Created, Lead Edited, Lead Status Changed, or Note Added, the Creation Rules section will appear below.
The Creation Rules section contains the following fields:
- Associated lead status - If you want the webhook to only occur for leads in a certain status, click the dropdown and select the desired status. If the lead status selected has associated substatuses, you have the option to select a substatus for the webhook.
- Case type - If you want the webhook to only occur for leads with a certain case type, click the dropdown and select the desired case type. To select multiple case types, hold the Ctrl (⌘Cmd for Macs) button down while selecting.
- Office - If you want the webhook to only occur for leads assigned to a certain office, click the dropdown and select the desired office.
- Opportunity Source - If you want the webhook to only occur for leads with a certain opportunity source, click the dropdown and select the desired source.
- Marketing Source - If you want the webhook to only occur for leads with a certain marketing source, click the dropdown and select the desired source.
- Requires Case Tracker Code - If you want the webhook to only occur for leads with a case tracker code, click the dropdown and select “Yes”.
When you have finished making your selections, click Save to create the webhook and return to the Webhook Rules section.
Edit or Delete
In the Webhook Rules section, click Edit beside the webhook you wish to edit. You are then taken to the Edit Webhook Rule form, where you can edit the desired fields for the webhook.
When you are finished editing, be sure to click Save.
You can also delete disabled webhooks from the Webhook Rules section. If you do not see the delete button beside a webhook, click the check mark in the Status column to disable the webhook. Then, click Delete.
Lead Docket will ask you to confirm the action before proceeding. Click OK to confirm.
Once confirmed, the webhook is deleted and a confirmation message appears in the top right corner.
Note: Deleted webhooks cannot be recovered. If you’d like to temporarily pause a webhook, but not delete, consider disabling it instead.
Lead Docket uses a unique webhook authentication key to verify webhooks. This authentication key appears at the bottom right of the Webhook Rules section.
When Lead Docket sends information to external services via webhook, Lead Docket takes the contents of the webhook and generates an SHA256 hash using your webhook authentication key. This hash is then used to verify the webhook.