Introduction to DealHub APIs

DealHub is a quote-to-cash ecosystem that unifies CPQ (Configure, Price, Quote), CLM (Contract Lifecycle Management), subscription management, and revenue recognition. While this documentation currently focuses on CPQ APIs, future releases will expand the API features available.

How DealHub CPQ Works

The core of the user experience (for salespeople) is the Playbook. A sales representative navigates a guided selling questionnaire, and based on their answers, the system automatically:

Generates the appropriate products.
Calculates pricing based on predefined rules.
Applies any necessary discounts or approval workflows.

This automated process replaces manual methods like using spreadsheets for pricing calculations and static templates for output documents.
An admin can also quickly update any changes to the entire organization, such as updating the design of output documents.

The platform is designed to be tailored for each specific customer's needs.

DealHub is governed by the customer's primary CRM, and the quoting process typically begins within the CRM. The platform has native connectors for major CRMs like Salesforce, HubSpot, and Microsoft Dynamics. The platform also supports sales through partner channels by integrating with Partner Relationship Management (PRM) systems.

The final output can be a traditional document (PDF, Word, Excel) or an interactive DealRoom. The DealRoom is a mini-website created for each sales opportunity, providing a central place for the customer to access pricing tables, files, and terms and conditions. Crucially, the DealRoom includes an e-signature widget, enabling customers to sign contracts directly within the platform.

The DealHub API

The DealHub API suite is the toolset that allows your applications to interact with the platform. Before you dive in, it helps to understand a few core concepts.

CRM-Governed

DealHub operates as a satellite to the primary CRM. The process usually starts in the CRM, and our APIs often rely on identifiers that originate there.

Version-Based Configuration

Most of the business logic, including products, pricing, and API configurations like External Queries, is encapsulated within a Version. Many API calls will function in the context of the currently active version.

A Hybrid Approach (API & UI)

Our APIs are built for system-to-system automation. While many tasks can be fully automated, the APIs and the UI are designed to work together. For example, an API can create a draft renewal quote, and a sales rep can then log into the UI to make final adjustments before sending it to the customer.

What You Can Do: Our API Categories

Our APIs are grouped into categories based on their primary function:

Quote Management

Get information from DealHub, such as details about quotes, users, and versions, to use in your own applications like a BI system or internal dashboard.

Headless Quotes

Generate a quote and perform actions (like submit or publish) entirely from a backend system, without any user interaction in the UI.

External Queries

Fetch data from an external system and inject it directly into a quote's playbook to influence the configuration.

Callouts

A specialized API used to fetch dynamic product pricing from an external system (like an ERP) at the moment a quote is being generated.

Next Steps

Authentication is required for all API calls. The method depends on the direction of the API call. To learn more about the authentication methods used by DealHub APIs, access the Authentication page.