---
sourceDocument: Brazil Sales Customer Relationship Management
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/order-management

 Release :

    - brazil

ft:locale :

    - en-US

ft:publication_title :

    - Brazil Sales Customer Relationship Management

ft:clusterId :

    - omgmt

bundleId :

    - omgmt

workflow :

    - Customer and Industry


---

# Integrating kBridge visualization

# Integrating kBridge visualization {#ariaid-title1}

Release version: Brazil  
Updated March 12, 2026  
![](https://www.servicenow.com/docs/portal-asset/ico-clock) 3 minutes to read
Summarize  
![AI sparkle icon](https://servicenow.com/docs/portal-asset/ai-sparkle-icon) Summarized using AI  
This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.  

## Summary of Integrating kBridge visualization

ServiceNow CPQ supports integration with kBridge to provide real-time 3D visualization within the end-user configuration experience.
This integration allows dynamic synchronization between configuration inputs and the 3D visual representation, enhancing the usability and interactivity of product configurations.
Show full answer Show less  
The integration can operate with one-way communication---from ServiceNow CPQ to kBridge---or with two-way communication, where user interactions with the 3D visualization also update CPQ configuration fields.

## Key Features

* **Real-time updates:** Configuration changes in ServiceNow CPQ instantly reflect in the kBridge visualization.
* **Bidirectional communication:** Optionally, user manipulations in the kBridge visualization update CPQ configuration fields.
* **Blueprint layout setup:** Integration is configured within the ServiceNow CPQ blueprint layout definition, specifying the rendering location, kBridge connection details, and mapped CPQ data fields.
* **Layout CSV configuration:** A kBridge layout component type is added in the layout CSV file, with JSON-formatted properties defining connection parameters, data mappings, and component dimensions.
* **Data mapping:** ServiceNow CPQ fields, sets, and product pickers are mapped to corresponding kBridge event objects to synchronize data.
* **Listener fields for two-way sync:** Specifies CPQ text fields to receive JSON data of sets manipulated in kBridge, requiring an admin-defined rule to parse and update CPQ inputs.
* **Optional output URL callback:** The rendered output can be sent to a specified URL upon session close, with support for authentication headers and appending quote IDs.

## Practical Implementation Details

Customers implement the integration by:

* Defining the kBridge component in the CPQ blueprint layout CSV, including the `scriptUrl`, `appUrl`, and `token` for authentication and connection.
* Mapping CPQ fields, sets, and product pickers to kBridge model paths (`refChain`) to ensure accurate data exchange.
* Configuring layout dimensions for the visualization component to fit the UI needs.
* Optionally setting callback URLs and headers to receive rendered outputs externally after the configuration session.
* Working with kBridge administrators or implementers to determine appropriate startup session parameters and data mappings.

## Benefits for ServiceNow Customers

* Enhances customer engagement by providing interactive and visually rich product configuration experiences.
* Improves accuracy and efficiency by keeping 3D visualizations in sync with configuration inputs.
* Enables advanced use cases where user interactions with the visualization can directly modify configuration data, supporting complex product customization.
* Offers flexibility to route final rendered outputs to external systems for further processing or archival.  
Integrate kBridge for real-time 3D visualization. Sync configuration inputs with visual updates to enhance user experience.
ServiceNow CPQ supports several different 3D visualization options in the end-user configuration experience. ServiceNow CPQ can be implemented to use kBridge as a visualization component. The component is updated in real time in the ServiceNow CPQ UI as the user changes configuration inputs (one-way communication). In addition, bidirectional (two-way) communication may be defined so that user manipulations of the graphic update ServiceNow CPQ configuration fields.

The following video shows how to integrate ServiceNow CPQ with kBridge for real-time updates:

[KBridge Integration Setup Demo](https://www.youtube.com/watch?v=X4sxdRtz_v4)

The integration between ServiceNow CPQ and kBridge is set up in the ServiceNow CPQ blueprint layout definition. The layout definition:

* defines where the kBridge visualization component will be rendered on the ServiceNow CPQ UI
* specifies the kBridge connection
* identifies the ServiceNow CPQ field or set data to be sent

{#cpq-kbridge-visualization-integration__ul_lqx_ssf_rgc}

To create a kBridge component, the `kbridge` layout component type can be added in the "type" column of the layout CSV file. Additional properties for the integration are set in the "value" column.

This sample layout CSV file demonstrates the use of the kBridge component and parameter inputs. See row 12.

[kBridge_setsv2-layoutCSV](https://docs.google.com/spreadsheets/d/1AqYC6enIGexuzgEC8e89GsVtd6lnRhUje0BiTkt2Uzs/edit?usp=sharing)

## JSON value template {#cpq-kbridge-visualization-integration__section_i4t_f3h_whc}

    scriptUrl: string,
    appUrl: string,
    token: string,
    sessionStartup: object
    eventFields: object
    eventSets: object
    eventProductPickers: object
    setActiveTriggers: array
    listenerFields: object
    height: number
    width: number

## kBridge connection {#cpq-kbridge-visualization-integration__section_mbl_33h_whc}

* scriptUrl: URL for kBridge script
* appUrl: URL for kBridge app
* token: Auth token from kBridge
* sessionStartup: Additional kBridge startup information; work with kBridge, your implementer or kBridge administrator to determine the appropriate values to pass in this parameter for your kBridge setup
{#cpq-kbridge-visualization-integration__ul_hyd_45f_rgc}

## ServiceNow CPQ data {#cpq-kbridge-visualization-integration__section_amn_j3h_whc}

* `eventFields`: Mapping of ServiceNow CPQ fields to kBridge
* `eventSets`: Mapping of ServiceNow CPQ sets to kBridge
* `eventProductPickers`: Mapping of ServiceNow CPQ product pickers to kBridge
* `setActiveTriggers`: ServiceNow CPQ set triggers
* `listenerFields`: For two-way data communication involving one or more ServiceNow CPQ sets, this object specifies the ServiceNow CPQ text field variable name to which a JSON representation of the set(s), manipulated in the kBridge visualization by the user, will be returned to ServiceNow CPQ. The Admin must define a rule that parses the content of the listenerFields and populates the appropriate set inputs.  
  Note:  
  * If a blueprint/layout has `eventFields` but not `listenerFields`, every event field has two-way communication.
  * If a listener field is added to the blueprint or layout, all event fields will communicate only from ServiceNow CPQ to kBridge.
  * Event sets and event product pickers pass information only from ServiceNow CPQ to kBridge, and not from kBridge to ServiceNow CPQ.
  * From a data standpoint, event sets and event product pickers data are passed the same way to kBridge (in an array of objects).
  {#cpq-kbridge-visualization-integration__ul_owr_y5f_rgc}
{#cpq-kbridge-visualization-integration__ul_dpc_t5f_rgc}

## Layout size {#cpq-kbridge-visualization-integration__section_gsb_l3h_whc}

* `height`: element height in layout, value is in pixels
* `width`: element width in layout, value is in pixels
{#cpq-kbridge-visualization-integration__ul_rrh_h5f_rgc}

## Example JSON values {#cpq-kbridge-visualization-integration__section_cyz_m3h_whc}

    {
      scriptUrl: 'http://script.location';,
      appUrl: 'http://app.script.location';,
      token: 'abc-123-def-456',
      sessionStartup: {
        type: 'model',
        revisionId: '1234-5678-90'
      },
      eventFields: {
        field1: { name: 'field-1', refChain: 'world.application.model' },
        field2: { name: 'field-2', refChain: 'world.application.model' },
        field3: { name: 'field-3', refChain: 'world.application.model' }
      },
      eventSets: {
        set1: { name: 'set-1', refChain: 'world.application.model' },
      },
      eventProductPickers: {
        picker1: { name: 'picker-1', refChain: 'world.application.model' },
      },
      setActiveTriggers: ['set.set2.triggerBoolean'],
      listenerFields: { 
        listenerFieldName: { name: 'logikTestSet', refChain: 'world.application.model' }
      },
      height: 800,
      width: 1200,
    }

* `name` corresponds to the field or rule name in kBridge.
* `refChain` corresponds to the model path of this object in kBridge.
{#cpq-kbridge-visualization-integration__ul_ffl_xtf_rgc}

## Output URL callback (optional) {#cpq-kbridge-visualization-integration__output-url-callback}

Render output can optionally be sent to a specified URL. To do this, set `callbackUrlField` on the layout JSON kBridge component to the variable name of a field whose value is the desired target URL. When the session
closes, kBridge sends the output URLs (as defined in `outputSources`) to that URL with a POST request. Optional: `callbackQuoteIdField`, `callbackAuthTokenField` and
`callbackCustomTokenField` name fields whose values are sent as the `X-QuoteId`, `Authorization: Bearer` and `X-CustomToken` headers. `appendQuoteId: true`
appends the quote ID to the URL.  

    {
      "callbackUrlField": "drawingCallbackUrl",
      "callbackQuoteIdField": "quoteId",
      "callbackAuthTokenField": "callbackAuthToken",
      "callbackCustomTokenField": "callbackCustomToken",
      "appendQuoteId": true,
      "outputSources": [
        { "name": "outputsUrl", "refChain": "world.root" }
      ]
    } 

## Reference {#cpq-kbridge-visualization-integration__section_wyh_q3h_whc}

For a discussion of features available among supported visualization applications in integration with ServiceNow CPQ, see [Visualization Integrations: An Overview](https://logikio.atlassian.net/wiki/spaces/CS/pages/1615462425/Visualization+Integrations+An+Overview).

