Open DealHub CPQ

The PRM client sends these requests using the access token received from the Authenticate Partner User step. Sending the requests from the client side ensures that the authentication cookie DealHub returns is stored in the browser, allowing the partner user to land directly inside DealHub CPQ without seeing a login screen.

Each request returns a redirect URL. The PRM system must redirect the partner user to this URL to open the CPQ session.

Prerequisites

Before making any requests on this page, ensure the following are in place. The Open DealHub CPQ requests depend on a valid access token obtained in the previous step. Without it, DealHub cannot establish an authenticated session for the partner user.

• A valid access token: The PRM server must have already completed the Authenticate Partner User request and passed the access_token to the client.
• Client-side execution environment: All requests on this page must originate from the PRM browser client, not the server.

The Open CPQ Workflow

Once the PRM client has the access token, complete the following sequence:

1. Include the access token in the Authorization header of the request.
2. Choose the appropriate endpoint based on whether the partner user needs to create a new quote, open an existing one, or view all quotes for an opportunity.
3. Send the request from the PRM browser client and redirect the partner user to the URL returned in the response.

Step 1: Set the Authorization Header

Include the access token as a Bearer token in the Authorization header of every request on this page:

Authorization: Bearer 4D114DAD97361C84B154A828FF991

🚧

Always send these requests from the PRM client

Along with the redirect URL, DealHub returns an authentication cookie in the response. This cookie is stored automatically only when the request originates from the browser. If the request is sent from the server, the cookie is not stored and the partner user will not be able to access DealHub CPQ without a login prompt.

Step 2: Choose and Send the Request

Select the endpoint that matches the partner user's intent. All three endpoints share the same authorization header and response structure.

Create a New Quote

Use this endpoint to direct the partner user to the quote creation flow for a specific opportunity.

Method: POST

URL: /api/v1/create/quote

Request body:

{
  "opportunity_id": "x444sh23lhr2jkk2"
}

📘

Default to this endpoint for new sessions

Use POST /api/v1/create/quote as the primary action when a partner clicks a Create Quote button in your PRM. The View an Existing Quote and View All Quotes endpoints are better suited for returning sessions where quotes already exist.

View an Existing Quote

Use this endpoint to direct the partner user to a specific quote that has already been created.

Method: POST

URL: /api/v1/open/quote

Request body:

{
  "opportunity_id": "lkdash23lhr2jkk2",
  "quote_id": "urhnvfkjsfdfdgrfdnbkg"
}

📘

Build a per-quote Open button when relevant

If your PRM lists existing quotes for an opportunity, place an Open button next to each one. Pass the corresponding quote_id and opportunity_id to take the partner directly to that quote, rather than making them navigate from the My Proposals page.

View All Quotes for an Opportunity

Use this endpoint to direct the partner user to the My Proposals page for a specific opportunity, where they can see all associated quotes.

Method: POST

URL: /api/v1/open/opportunity

Request body:

{
  "opportunity_id": "lkdash23lhr2jkk2"
}

Parameters

Step 3: Handle the Response and Redirect

A successful request returns HTTP 200 and a DealHub URL.

{
  "url": "https://service-eu1.dealhub.io/.../",
  "errors": []
}

Redirect the partner user to the returned url immediately.

❗️

Redirect without delay

The redirect URL is tied to the authenticated session established by the access token. Delaying the redirect may result in a broken or unauthorized session. Trigger the redirect as soon as the response is received.

Next Steps

The partner user is now inside DealHub CPQ and can create or review quotes. Upon submitting a quote, DealHub automatically syncs the quote details back to the CRM.

📘

Related API Reference

The following API Reference pages document the endpoints used in this guide:

• Get URL to Create a New Quote
• Get URL to Open an Existing Quote
• Get URL to View an Opportunity's Quotes