Webhooks

Article Overview 

A Webhooks is a mechanism that allows one system to send real-time data to another system automatically when a specific event occurs. It "pushes" information to a designated URL without requiring the receiving system to check for the updates. SalesRabbit+ users can create and manage webhooks for their accounts, allows for data to be send through a webhook.

Note: Webhooks are only available to SalesRabbit+ Pro Plan accounts.

Part 1: Webhook Permission

In order to create/manage webhooks, a user's role must have the correct permissions for it. Owners and Admins can update the permissions for any role from the Web App.

• From the Web App, navigate to "Settings" -> select "Roles & Permissions".
• Select the role you'd like to edit -> ensure the "Integrations" permission is enabled.
• Don't forget to click "Save" to apply any changes made!

Part 2: Create a Webhook 

This part will cover how to create/manage a webhook for your workspace.

• From the Web App, navigate to "Integrations" -> select "Webhooks".
• Click the "Create Webhook" button in the upper right corner to create a new webhook.

• From the right pop-out, enter the following information:
  • Title: provide a title for the webhook in this field.
  • URL: paste the URL for the webhook in this field.
  • Event Type: choose the event type (trigger) to send information. Available triggers include:
    • Form Triggers:
      • Form Submitted: event triggers every time a specific form/multiple selected forms are submitted.
    • Lead Triggers:
      • Lead Created: triggers when a lead is created with a specific lead status.
      • Lead Updated: triggers when a lead marked with a specific status is updated (incl. lead status change, name/email/phone/address/etc. updates).
      • Any time a lead with a specific status is updated (incl. lead status change, name/email/phone/address/etc. updates)
      • Lead Deleted: triggers when a lead with a specific lead status is deleted.
      • Lead Status Updated: triggers when a lead is updated to a specific status.
      • Lead Owner Modified: triggers when a specific lead status has the assignee/owner updated.
      • Event Sub-Type: this dropdown will appear for webhooks based on a lead trigger. use the dropdown field to select the lead status(es) acting as the trigger for the webhook.
    • Area Triggers:
      • Area Created: triggers when a new area is created.
      • Area Updated: triggers when an area is updated (Area Name Change, Team/Assignee Updates, Color Updates).
      • Area Deleted: triggers when a new area is deleted.
• Click the "Create" button to save your webhook.

• The new webhook will display under the list of "Active" webhooks.
• Select the three dot icon to the right to "Edit", "Deactivate", or "Delete" an active webhook at any time. 
  • Note: Deactivated webhooks will live under the "Deactivated" list on the same page and can be "Activated".

Webhook FAQs

• What is the difference between a Webhook and an API?
  • Webhook: a mechanism that allows one system to send real-time data to another system automatically when a specific event occurs. It "pushes" information to a designated URL without requiring the receiving system to check for the updates.
  • API (Application Programming Interface): a set of rules and protocols that allows one system to request data from another system. It requires systems to "pull" information by making calls to retrieve data. API requires "polling" AKA the API is constantly looking for updates at whatever the defined time is (searches for updates every 10min).
  • Key difference: webhooks push data automatically when events happen, while APIs require you to actively request data. Think of webhooks as notifications that come to you, and APIs as you calling to ask for information.
• Where can I send data through webhooks?
  • Automation Platforms (Zapier, Make.com/Integromat, Tray.io): these are "middlemen" that catch the data an dpass it to 5,000+ other apps without writing code.
  • CRMs & ERPs (HubSpot, Salesforce, Job Nimbus, Rooflink): the data goes here to update a lead's status, create an invoice, or start a project.
  • Communication Tools (Slack, Microsoft Teams, Twilio): the data triggers a notification so a manager knows a deal was just closed.
  • Custom Servers (AWS Lambda, Google Cloud Functions): advanced customers send data to their own private databases or custom-built apps.
• Note: almost every modern business tool provides a unique URL in its settings specifically designed to "catch" data sent from webhooks.