---
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


---

# Webhooks

# Webhooks {#ariaid-title1}

Release version: Brazil  
Updated March 12, 2026  
![](https://www.servicenow.com/docs/portal-asset/ico-clock) 5 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 Webhooks in ServiceNow CPQ

Webhooks in ServiceNow CPQ are endpoints that receive HTTP POST requests whenever a configuration is saved.
This functionality enables integration between ServiceNow CPQ and external systems by automatically sending configuration data on save events.
Show full answer Show less  
To enable webhooks, customers must log a support case with ServiceNow, noting that only one webhook can be configured per CPQ environment. Once enabled, webhooks are accessible via the Utilities menu in the ServiceNow CPQ Admin screen.

## Key Features

* **Webhook Configuration:** Similar to external connections, webhooks allow you to define name, description, integration type, and authentication method (None or Bearer Token).
* **Webhook Details:** Specify the endpoint URL that accepts POST requests, and configure behavior such as asynchronous processing (immediate user redirect without waiting for webhook response) or synchronous processing (waits for webhook response before redirecting).
* **Content Options:** Choose which data to send:
  * Config Data: All admin-created configuration fields and values.
  * BOM and System Fields: System-generated configuration fields and bill of materials data, with selectable BOM types.
* **Timeout and Headers:** Set request timeout in milliseconds and add custom headers as key-value pairs for enhanced request control.

## Use Cases

* Display CPQ native UI via direct URLs and send configuration results to third-party destinations.
* Send configuration data directly to quoting or order management systems for streamlined order processing.
* Push configuration results to middleware for data manipulation and forwarding to downstream systems.

## Webhook Payload

The payload sent to the external endpoint contains comprehensive configuration details including:

* Unique configuration identifier (UUID).
* Configuration fields with metadata such as data type, visibility, editability, variable names, and values.
* Detailed product information including quantities, pricing, bill of materials, and system fields.
* Aggregate values and system-related metadata like product codes, dates, and pricing details.

This structured JSON payload enables receiving systems to accurately interpret and use the configuration data.

## Practical Considerations for ServiceNow Customers

* Only one webhook can be configured per CPQ environment, so plan your integration endpoint accordingly.
* Choose synchronous or asynchronous processing based on whether you require immediate confirmation of webhook processing before user redirection.
* Utilize authentication options to secure your webhook endpoint and ensure trusted data exchange.
* Configure the content and BOM types carefully to send only the necessary data, optimizing integration performance.
* Use custom headers and timeout settings to tailor requests to your external system requirements.  
Webhooks are endpoints that can receive a POST request whenever a configuration is saved.

ServiceNow CPQ supports webhooks: endpoints that can receive a POST request when a configuration is saved. Once a webhook has been configured, it is called on every save configuration action.

To enable webhooks, log a case with support. Only one webhook can be created per ServiceNow CPQ environment.  
Note:  
Create a support case by using the [ServiceNow Support portal](https://support.servicenow.com). For step-by-step instructions, see [Create a case on Now Support for CPQ Customers](https://support.servicenow.com/kb?sys_kb_id=d67d3e71475d7a90f64de825126d4326&id=kb_article_view).

## Webhook use cases {#cpq-webhooks__Webhook-Use-Cases}

Webhooks can be used to integrate data from ServiceNow CPQ to other downstream systems. Use cases include:

* Displaying the ServiceNow CPQ native UI via direct URL and sending the config result, via webhook, to a third-party destination. See:

  [Use case: Displaying the ServiceNow CPQ native UI via direct URL](https://servicenow-prod.fluidtopics.net/8h50APpfJjJ0WXPUgH9D_Q "Learn how to initialize a configuration UI using a URL instead of an external library.")
* Sending config data directly to a quoting or order management system
* Pushing the configuration result to middleware that can manipulate the data and pass it along to downstream systems

{#cpq-webhooks__ol_n4w_yqn_3hc}

[Webhook demo](https://youtu.be/khjWIDJ9SHk)

## Webhook setup {#cpq-webhooks__section_yxy_mrn_3hc}

* When webhooks are enabled, they can be found in the Utilities menu in the ServiceNow CPQ Admin screen.
* Summary: Webhook configuration is similar to external connections. The Name, Description and Integration type can all be defined.
* Authentication: Webhooks support both no authentication (None) as well as bearer token authentication (Bearer Token).
* Webhook Details: Additional details of the webhook can be specified as well to control the behavior.
{#cpq-webhooks__ol_p4w_yqn_3hc}

## Webhook details {#cpq-webhooks__section_irw_wrn_3hc}

1. URL: The endpoint to receive the data from ServiceNow CPQ on save of a configuration. Must be able to receive an HTTP POST request.
2. Async: When enabled, ensures that the end user is redirected immediately when a configuration is completed and does not wait for a response from the server before exiting. The save process is asynchronous.When disabled, this
   ensures that the webhook process is resolved before the user is redirected. The save process is synchronous.

3. Content: The data that ServiceNow CPQ should send to the endpoint.
   * Config Data: all admin-created configuration fields and their input values
   * BOM and System Fields: all system configuration fields and their values; the bill of materials (as specified in the BOM Types input immediately below)
   {#cpq-webhooks__ul_gg4_ssn_3hc}
4. BOM Types: The BOM types to be sent in the request.
5. Timeout: The timeout value in milliseconds
6. Additional Headers: Additional headers that should be sent along with the request, entered as quoted key value pairs. For example, <kbd class="ph userinput">"X-header1": "value1"</kbd>
{#cpq-webhooks__ol_r4w_yqn_3hc}

## Example webhook body {#cpq-webhooks__Example-Webhook-Body}

The body that the webhook sends to the external resource looks like the following. This example covers product pickers and the built-in system fields from an environment.

    {
      "uuid": "8014a955-49c4-4d63-a15a-8c91cef6f6f4",
      "fields": [
        {
          "userEdited": false,
          "dataType": "array",
          "visibilityState": "visible",
          "editable": "true",
          "variableName": "pp",
          "uniqueName": "pp",
          "value": ["alpha"],
          "optionSet": {
            "selectedOptions": [
              {
                "label": "alpha",
                "state": "visible",
                "value": "alpha",
                "imageUrl": null,
                "orderNumber": 10
              }
            ],
            "options": [
              {
                "label": "alpha",
                "state": "visible",
                "value": "alpha",
                "imageUrl": null,
                "orderNumber": 10
              },
              {
                "label": "beta",
                "state": "visible",
                "value": "beta",
                "imageUrl": null,
                "orderNumber": null
              }
            ]
          },
          "rows": {
            "content": [
              {
                "index": 0,
                "fields": [
                  {
                    "userEdited": false,
                    "dataType": "text",
                    "visibilityState": "visible",
                    "editable": "false",
                    "variableName": "pp.value",
                    "uniqueName": "pp-0-pp.value",
                    "value": "alpha",
                    "set": "pp",
                    "index": 0
                  },
                  {
                    "userEdited": true,
                    "dataType": "boolean",
                    "visibilityState": "visible",
                    "editable": "true",
                    "variableName": "pp.select",
                    "uniqueName": "pp-0-pp.select",
                    "value": true,
                    "optionSet": {
                      "options": [
                        {
                          "label": "true",
                          "state": "visible",
                          "value": "true",
                          "imageUrl": null,
                          "orderNumber": null
                        },
                        {
                          "label": "false",
                          "state": "visible",
                          "value": "false",
                          "imageUrl": null,
                          "orderNumber": null
                        }
                      ]
                    },
                    "set": "pp",
                    "index": 0
                  },
                  {
                    "userEdited": false,
                    "dataType": "number",
                    "visibilityState": "visible",
                    "editable": "true",
                    "variableName": "pp.quantity",
                    "uniqueName": "pp-0-pp.quantity",
                    "value": 1,
                    "set": "pp",
                    "index": 0
                  },
                  {
                    "userEdited": false,
                    "dataType": "text",
                    "visibilityState": "visible",
                    "editable": "true",
                    "variableName": "pp.data",
                    "uniqueName": "pp-0-pp.data",
                    "value": "",
                    "set": "pp",
                    "index": 0
                  }
                ],
                "label": "alpha",
                "state": "visible",
                "value": "alpha",
                "imageUrl": null,
                "orderNumber": 10,
                "productDetails": {}
              },
              {
                "index": 1,
                "fields": [
                  {
                    "userEdited": false,
                    "dataType": "text",
                    "visibilityState": "visible",
                    "editable": "false",
                    "variableName": "pp.value",
                    "uniqueName": "pp-1-pp.value",
                    "value": "beta",
                    "set": "pp",
                    "index": 1
                  },
                  {
                    "userEdited": false,
                    "dataType": "boolean",
                    "visibilityState": "visible",
                    "editable": "true",
                    "variableName": "pp.select",
                    "uniqueName": "pp-1-pp.select",
                    "value": false,
                    "optionSet": {
                      "options": [
                        {
                          "label": "true",
                          "state": "visible",
                          "value": "true",
                          "imageUrl": null,
                          "orderNumber": null
                        },
                        {
                          "label": "false",
                          "state": "visible",
                          "value": "false",
                          "imageUrl": null,
                          "orderNumber": null
                        }
                      ]
                    },
                    "set": "pp",
                    "index": 1
                  },
                  {
                    "userEdited": false,
                    "dataType": "number",
                    "visibilityState": "visible",
                    "editable": "true",
                    "variableName": "pp.quantity",
                    "uniqueName": "pp-1-pp.quantity",
                    "value": 0,
                    "set": "pp",
                    "index": 1
                  },
                  {
                    "userEdited": false,
                    "dataType": "text",
                    "visibilityState": "visible",
                    "editable": "true",
                    "variableName": "pp.data",
                    "uniqueName": "pp-1-pp.data",
                    "value": "",
                    "set": "pp",
                    "index": 1
                  }
                ],
                "label": "beta",
                "state": "visible",
                "value": "beta",
                "imageUrl": null,
                "orderNumber": null,
                "productDetails": {}
              }
            ],
            "pageable": "INSTANCE",
            "last": true,
            "totalPages": 1,
            "totalElements": 2,
            "size": 2,
            "number": 0,
            "sort": { "empty": true, "sorted": false, "unsorted": true },
            "numberOfElements": 2,
            "first": true,
            "empty": false
          }
        },
        {
          "userEdited": false,
          "dataType": "text",
          "visibilityState": "visible",
          "editable": "true",
          "variableName": "sys.productCode",
          "uniqueName": "sys.productCode",
          "value": "CC-LGK"
        },
        {
          "userEdited": false,
          "dataType": "text",
          "visibilityState": "visible",
          "editable": "true",
          "variableName": "partner.quote.pricebookId",
          "uniqueName": "partner.quote.pricebookId",
          "value": ""
        },
        {
          "userEdited": false,
          "dataType": "text",
          "visibilityState": "visible",
          "editable": "true",
          "variableName": "partner.quote.currencyIsoCode",
          "uniqueName": "partner.quote.currencyIsoCode",
          "value": "USD"
        },
        {
          "userEdited": false,
          "dataType": "text",
          "visibilityState": "visible",
          "editable": "true",
          "variableName": "sys.productFamily",
          "uniqueName": "sys.productFamily",
          "value": ""
        },
        {
          "userEdited": false,
          "dataType": "text",
          "visibilityState": "visible",
          "editable": "true",
          "variableName": "sys.productDescription",
          "uniqueName": "sys.productDescription",
          "value": ""
        },
        {
          "userEdited": false,
          "dataType": "text",
          "visibilityState": "visible",
          "editable": "true",
          "variableName": "partner.quote.id",
          "uniqueName": "partner.quote.id",
          "value": ""
        },
        {
          "userEdited": false,
          "dataType": "text",
          "visibilityState": "visible",
          "editable": "true",
          "variableName": "sys.productUOM",
          "uniqueName": "sys.productUOM",
          "value": ""
        },
        {
          "userEdited": false,
          "dataType": "number",
          "visibilityState": "visible",
          "editable": "true",
          "variableName": "sys.productPrice",
          "uniqueName": "sys.productPrice",
          "value": 0
        },
        {
          "userEdited": false,
          "dataType": "text",
          "visibilityState": "visible",
          "editable": "true",
          "variableName": "sys.productName",
          "uniqueName": "sys.productName",
          "value": "CheckConfig"
        },
        {
          "userEdited": false,
          "dataType": "text",
          "visibilityState": "visible",
          "editable": "true",
          "variableName": "partner.quote.lineId",
          "uniqueName": "partner.quote.lineId",
          "value": ""
        },
        {
          "userEdited": false,
          "dataType": "number",
          "visibilityState": "visible",
          "editable": "false",
          "variableName": "pp.aggregates.quantity_sum",
          "uniqueName": "pp.aggregates.quantity_sum",
          "value": 1
        },
        {
          "userEdited": false,
          "dataType": "text",
          "visibilityState": "visible",
          "editable": "true",
          "variableName": "sys.productId",
          "uniqueName": "sys.productId",
          "value": "CC-LGK"
        },
        {
          "userEdited": false,
          "dataType": "text",
          "visibilityState": "visible",
          "editable": "true",
          "variableName": "sys.actionContext",
          "uniqueName": "sys.actionContext",
          "value": ""
        },
        {
          "userEdited": false,
          "dataType": "text",
          "visibilityState": "visible",
          "editable": "true",
          "variableName": "sys.currentDate",
          "uniqueName": "sys.currentDate",
          "value": "2023-08-04"
        }
      ],
      "products": [
        {
          "id": "alpha",
          "quantity": 1,
          "bomType": "SALES",
          "type": "accessory",
          "extended": { "data": "" },
          "pricing": {
            "productSellingModelId": "OneTime_OneTime_2023_07_05",
            "endDate": null,
            "startDate": null,
            "ProductId": "01tHr000007i4B5IAI",
            "StartingUnitPriceSource": "System",
            "ListPrice": 99.99,
            "TotalLineAmount": 99.99,
            "ListPriceTotal": 99.99,
            "StartingPriceTotal": 99.99,
            "Quantity": 1.0,
            "PricingTermCount": 1,
            "NetUnitPrice": 99.99,
            "StartingUnitPrice": 99.99,
            "PricebookEntryId": "01uHr00000FYKDUIA5",
            "TotalAdjustmentDistAmount": 0,
            "TotalAdjustmentAmount": 0,
            "TotalPrice": 99.99,
            "SalesItemType": "Product"
          },
          "name": "alpha",
          "partnerId": "01tHr000007i4B5IAI",
          "productCode": "alpha",
          "externalId": "",
          "productFamily": "",
          "description": "",
          "uom": "",
          "price": 99.99,
          "extPrice": 99.99,
          "level": 0,
          "rollUpPrice": 99.99
        }
      ],
      "total": 99.99
    }


