ServiceNow CMDB Integration

Traceable's integration with ServiceNow CMDB allows you to import API-related metadata from the Traceable platform into your ServiceNow environment using the Service Graph Connector. This enables your organization to treat APIs as assets in the CMDB, visualize API relationships, and maintain an up-to-date inventory of API components, deployments, and services in your asset management workflows.

The integration is packaged as a Service Graph Connector application, which can be installed from the ServiceNow Store. Once installed and configured, the application pulls data from Traceable and maps it into CMDB tables on a scheduled basis.

Note

The current version of the connector is certified for the Xanadu, Yokohama, Zurich, and Australia release of ServiceNow.

What you will learn from this topic

By the end of this topic, you will be able to:

• Understand the CMDB tables used for API data from Traceable.

• Install and configure the Service Graph Connector application.

• Set up connection credentials and data mappings.

• Define an import schedule for syncing API metadata.

• View API-related records and relationships within ServiceNow CMDB.

Before you begin

Before setting up the integration, make a note of the following:

• Make sure you have a valid ServiceNow instance running Xanadu, Yokohama, Zurich, and Australia.

• Make sure you have access to the Traceable Service Graph Connector application. For more information, see Traceable Service Graph Connector on the ServiceNow Store.

• Make sure you have access to CMDB workspace,  IntegrationHub ETL, and Service Graph Connector capabilities.

• Make sure you have admin-level permissions in ServiceNow.

• Make sure you have access to your Traceable API token and Traceable platform URL. For more information, see Public APIs.

Supported CMDB tables and field mappings

Traceable maps API metadata into the following ServiceNow CMDB tables:

Example field mappings

The following tables discuss the different types of field mappings:

API component table

API table

API deployment table

Note

Traceable flattens multi-valued field, such as domains or environments to construct unique identifiers like domain, environment, entityId to handle cases where APIs share the same name across domains.

Integration steps

To complete the integration between Traceable and your ServiceNow CMDB, you can perform three main tasks:

1. Configure the connection and credentials to allow ServiceNow to connect to the Traceable platform.

2. Set up field mappings to ensure API data from Traceable is correctly aligned with CMDB tables.

3. Define an import schedule to periodically sync API metadata into ServiceNow.

Follow the steps below to complete the configuration:

Step 1 — Configure connection and credentials

To configure the connection, complete the following details:

1. In the CMDB Workspace, navigate to Overview → SGC Central → Create Connection → Traceable Connector.

2. Add the Details for the new connection:

   

   • Specify the Connection Name according to your requirements.

   • Specify the Base Connection URL, for example, https://api.traceable.ai/grapghql.

   • Specify the API Key fetched from the Traceable platform, for example, <your_traceable_api_key>. For information, see API Keys.

3. Click Update and test connection to confirm your connection.

Step 2 — Configure field mapping

Traceable provides a default mapping configuration that can be edited using the IntegrationHub ETL.

1. Navigate to the CMDB workspace.

2. Open the IntegrationHub ETL configuration for Traceable.

3. Ensure the Sample Import Set is set to Auto pull sample data.

4. In Prepare and Preview Data, optionally transform fields and preview the import set.

5. Use Map Data to CMDB and Add Relationships to:

   • Define the relationships among the API, API Component, and API Deployment tables.

   • Add custom mappings to other internal CMDB tables if needed.

6. Save the configuration.

Note

Some fields are required based on ServiceNow's identification rules. These are auto-configured by default. If you modify mappings manually, ensure that primary keys (like id or name) are set correctly.

Step 3 — Configure import schedule

To configure the import schedule, complete the following steps:

1. Navigate to  All → Scheduled Imports to the import schedule settings for the Traceable connector.

2. Click the default schedule Traceable Default Schedule and set it to run once.

3. You can review and modify the provided default schedule to match your data refresh interval according to your requirements.

4. Save the schedule to activate automated imports.

View imported data

Once the integration is configured and the scheduled import runs successfully, the API metadata from Traceable will be visible in your ServiceNow CMDB. You can explore the imported records in the following tables:

• API Component Table (cmdb_ci_api_component) — View components by domain, API name, and environment.

• API Table (cmdb_ci_api) — View API methods, discovery timestamps, and other metadata.

• API Deployment Table (api_deployment) — View deployment-level details including protocol type and timestamps.

You can also view imported APIs and their relationships in the CMDB 360° View Dashboard, if enabled.

Note

Repeated imports are idempotent, existing entries are updated and not duplicated.

Metrics and monitoring

Traceable adds a custom header to identify integration traffic:

User-Agent: servicenow-cmdb

This allows Traceable to:

• Monitor and track usage of the CMDB connector

• Identify which customer instance is sending the request

• Troubleshoot rate limiting or payload-related issues

Note

Data is fetched using paginated GraphQL queries, with batching of up to 1000 APIs per request. This ensures scalability for large API inventories.

Troubleshooting

If the import encounters invalid or missing fields:

• Errors are logged in the ServiceNow application logs (no alert is automatically triggered).

• Review the logs within ServiceNow to identify the issue.

• If the problem is due to mapping changes, revert or correct the mapping configuration.

• If the error is on the Traceable platform side, contact Traceable Support.

Additional notes

• API metadata includes additional fields beyond those mapped by default. You may customize mappings within IntegrationHub ETL to include more fields if required.

• If Traceable introduces new API metadata fields in the future, a new version of the connector will be released with updated mapping templates.