Quote transaction integrations
Summarize
Summary of Quote transaction integrations
Quote transaction integrations enable ServiceNow’s Transaction Manager to connect with external data sources, facilitating data exchange between quotes and third-party systems like Salesforce within CPQ. These integrations allow you to both extract data from external systems into Transaction Manager and send Transaction Manager data back to third-party environments.
Show less
Connection Types
Two types of connections are supported to establish integrations:
- Salesforce: Automatically handles authentication and endpoint details for Salesforce environments without requiring additional credentials.
- External: Connects to any other third-party site, supporting authentication methods such as None, Bearer Token (authentication token required), and OAuth (requires Client ID, Client Secret, and Token URL). You also specify Host URL, endpoint Path, and any extra headers needed by the third-party.
Integration Configuration
When creating an integration in the Integration Editor, you can configure:
- HTTP Method: Choose the operation type to perform on the endpoint (GET, POST, PATCH, PUT, DELETE).
- Line Item Details to Include: Specify which quote line items to process (Selected, Modified, or Deleted Lines).
- Additional Path: Define the query to execute on the third-party system (e.g., SOQL for Salesforce or SQL for others).
- Timeout: Set the maximum wait time in milliseconds for a response before erroring out.
- Async: Optionally run the integration asynchronously to allow users to continue working while the integration runs.
- Headers: Add static or dynamic header values using handlebar syntax (e.g.,
{{txn.fieldname}}) for authentication or other purposes.
Data Transformation
The transformation template defines how data from third-party sources maps into Transaction Manager fields. It uses JSON with Mustache (handlebar) syntax to dynamically extract and assign values. You can test and troubleshoot these mappings by pasting sample response data (e.g., from Postman) into the Sample Return Data area and running the transformation to verify results.
Practical Benefits for ServiceNow Customers
- Seamlessly synchronize quote data between Transaction Manager and external systems like Salesforce.
- Customize data extraction and submission to fit your business rules and external API requirements.
- Support secure and flexible authentication methods for diverse third-party integrations.
- Improve user experience by optionally running data exchanges asynchronously.
- Validate integration mappings quickly to reduce errors and ensure data accuracy.
Integrations connect Transaction Manager to external data sources, enabling the exchange of data between quotes and third-party systems such as Salesforce in CPQ.
Transaction Manager integrations define the information needed to connect to an external data source, extract data from it, and map that data into Transaction Manager fields. Integrations can also extract data from Transaction Manager and send it to a third-party environment. Before an integration can be defined, the administrator must first create a connection to the target environment.
Connection types
Transaction Manager supports two connection types.
- Salesforce
- Connects to a Salesforce environment. No additional authentication details are required — CPQ handles authentication and knows the required endpoints automatically.
- External
- Connects to any third-party site. Supported authentication methods are None, Bearer Token, and OAuth. For Bearer Token, provide the authentication token. For OAuth, provide the Client ID, Client Secret, and Token URL. Also requires the Host URL, the Path to the endpoint, and any additional headers required by the third-party site.
Integration settings
When creating an integration, the following settings are available in the Integration Editor.
- HTTP Method
- The operation to perform: GET, POST, PATCH, PUT, or DELETE, depending on the endpoint being used.
- Line Item Details to Include
- Defines which line items the integration works with: Selected Lines, Modified Lines, or Deleted Lines.
- Additional Path
- The query command to execute on the third-party site. For Salesforce connections, this is typically a SOQL query. For other platforms, it may be a standard SQL query.
- Timeout
- The time in milliseconds that the request waits for a response before declaring an error.
- Async
- When enabled, runs the query asynchronously in the background so the user can continue working while the integration executes.
- Headers
- Static text or Transaction Manager header field values can be included in
headers using handlebar syntax:
{{txn.fieldname}}. Static key-value pairs can also be set, or both methods can be combined.
Transformation template
The transformation template defines the mapping between third-party data and CPQ fields. It uses JSON with Mustache (handlebar) syntax for dynamic field extraction. The following example maps Salesforce fields to Transaction Manager fields.
{
"fields": [
{
"variableName": "txn.custom.tXNNumber",
"value": "{{#each records}}{{Name}}{{/each}}"
},
{
"variableName": "txn.opportunity.id",
"value": "{{#each records}}{{LGK__OpportunityId__c}}{{/each}}"
},
{
"variableName": "txn.custom.primaryContact",
"value": "{{#each records}}{{Contact.FirstName}}{{/each}}"
}
]
}Use the Sample Return Data and Transformation Result areas to test and troubleshoot an integration. Paste the query response from a tool such as Postman into the Sample Return Data area and select Run Transformation to verify that the mapping produces the expected output.