Guides

Webhooks Overview

Suggest Edits

Webhooks are a powerful tool for creating event-driven integrations with the DealHub platform. Instead of you needing to constantly ask DealHub for updates, Webhooks will automatically send a notification to your system whenever a specific event occurs.

How It Works

Webhooks follow an automatic process that is described by the following steps.

  1. An event happens in DealHub (e.g., a sales rep submits a quote for approval).
  2. DealHub automatically sends an HTTP POST request with a JSON payload to an endpoint URL that you have configured.
  3. Your application, which is listening at that endpoint, receives the notification and can trigger a downstream workflow.

This model is ideal for building integrations that need to react in real-time to actions taken by your sales team.

Webhooks Triggers

Webhooks are published for various activities related to the main business entities in DealHub, such as Quotes, Versions, and Users. While you can subscribe to many events, the most commonly used ones are related to the Quote Lifecycle:

  • draftQuote: A quote is created or saved as a draft.
  • quotePendingApproval: A quote that requires approval has been submitted.
  • quoteReady: A quote is fully approved and ready to be sent to the customer.
  • quotePublished: A quote has been published to its DealRoom.
  • quoteWon: A quote has been signed and the deal is marked as "Won".
  • quoteRejected: An approver has rejected a quote.

📘

Webhooks Use Case

A powerful use case for webhooks is integrating with a Business Intelligence (BI) system:

  1. Configure a webhook to listen for the quoteWon event.
  2. When a deal is won, your endpoint receives the webhook notification.
  3. Your application extracts the dealhub_quote_id from the payload.
  4. Your application then calls the Get Quote API using that ID to fetch all the detailed line items and answers from the quote.
  5. This detailed data is then logged in your BI system for analysis and reporting.

This workflow allows you to sync rich data without cluttering your CRM, as all the interaction happens directly between your application and DealHub.

The Webhook Payload

Every webhook is sent with a JSON payload containing details about the event. All payloads include a standard event_info object, which contains:

  • webhook_id: The unique identifier of the webhook configuration.
  • event_id: A unique identifier for this specific event notification.
  • api_version: The version of the API that sent the event.
  • request_id: An identifier included only if the event was triggered by an asynchronous Open API call.

For quote-related events, the payload will also contain essential identifiers like dealhub_quote_id and dealhub_opportunity_id, which you can use to make subsequent API calls. You can also configure DealHub to include answers to specific playbook questions in a field called additional_data.

Next Steps

To learn how to configure the Webhooks to start receiving notifications from Dealhub, access the How to Configure Webhooks page.

Updated 2 months ago