Ctrlk
Sign UpGet a DemoContact Us
For the complete documentation index, see llms.txt. This page is also available as Markdown.

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.

The current version of the connector is certified for the Xanadu release of ServiceNow (version 10.x patch 4 and above).

What you will learn

In this topic, you will learn how 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, ensure the following prerequisites are in place:

  • A valid ServiceNow instance running Xanadu (version 10.x patch 4 and above).

  • Access to IntegrationHub ETL and Service Graph Connector capabilities.

  • Admin-level permissions in ServiceNow.

  • Access to your Traceable API token and Traceable platform URL.

  • Access to the Traceable Service Graph Connector application — Traceable Service Graph Connector on the ServiceNow Store.

Supported CMDB tables and Field Mappings

Traceable maps API metadata into the following ServiceNow CMDB tables:

CMDB Table
Description

cmdb_ci_api_component

Represents individual API components. Each row corresponds to a combination of API name, domain, and environment.

cmdb_ci_api

Represents API entities, including HTTP method, discovery timestamps, and other metadata.

api_deployment

Captures deployment-level information such as protocol type, base URL, and start time.

Example Field Mappings

API Component Table

CMDB Column
Traceable Field
Sample Value

id

entityId

d86d21b4-80a7-3ef5-9327-2731bf58470f

name

entityName

/v7/loans

environment

environment

production

owned_by

owner

api-team@company.com

url

domainName + path

www.userservice.com/v7/loans

API Table

CMDB Column
Traceable Field
Sample Value

name

entityName

/v7/loans

method

httpMethod

POST

vendor

—

Traceable

first_discovered

createdTimestamp

2024-04-25 06:47:12

last_discovered

lastCalledTimestamp

2024-04-25 06:47:12

internet_facing

isExternal

True

API Deployment Table

CMDB Column
Traceable Field
Sample Value

id

entityId

d86d21b4-80a7-3ef5-9327-2731bf58470f

base_url

domainName

www.userservice.com

name

entityName

/v7/loans

type

displayApiType

REST

environment

environment

production

last_discovered

lastCalledTimestamp

2024-04-25 06:47:12

Note

Traceable flattens multi-valued fields (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 will 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 sync API metadata into ServiceNow periodically.

Follow the steps below to complete the configuration:

Step 1 — Configure connection and credentials

  1. In ServiceNow, go to All → Credentials.

  2. Create a new credential of type API Key:

    • Name: Traceable API Key

    • API Key: <your_traceable_api_key>

  3. Navigate to the Traceable Integration Setup page.

  4. Add a new connection:

    • Connection name: TraceableConnection

    • Base URL: https://api.traceable.ai/graphql (replace with your cluster URL if different)

    • Timeout (in milliseconds): 5000

    • Credentials alias: Traceable API Key

  5. Save the connection settings.

Step 2 — Configure Field Mapping

Traceable provides a default mapping configuration, which can be edited using IntegrationHub ETL.

  1. Open the IntegrationHub ETL configuration for Traceable.

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

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

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

    • Define relationships between API, API Component, and API Deployment tables

    • Add custom mappings to other internal CMDB tables if needed

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

  1. Navigate to the import schedule settings for the Traceable connector.

  2. Review and modify the provided default schedule to match your data refresh interval.

  3. Save the schedule to activate automated imports.

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

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.

PreviousServiceNow ITSM integration
NextAzure DevOps Integration

Last updated

Was this helpful?