servicenow_integrations

Creates, updates, deletes, gets or lists a servicenow_integrations resource.

Overview

Name	servicenow_integrations
Type	Resource
Id	pagerduty.enrichment.servicenow_integrations

Fields

The following fields are returned by SELECT queries:

get

The requested ServiceNow enrichment integration, including its CMDB tables, field mappings, and credentials.

Name	Datatype	Description
id	string	Base32-encoded UUID v7 (26 uppercase alphanumeric characters) identifying the integration.
name	string	The name of the integration.
cmdb_tables	array	The ServiceNow CMDB table configurations belonging to this integration. An integration must have at least 1 and at most 8 tables.
created_at	string (date-time)	The date/time the integration was created.
credentials	object	The ServiceNow credentials associated with the account, or null if no credentials have been configured. Credentials are managed through the credentials endpoints, not through this object.
description	string	An optional description of the integration.
updated_at	string (date-time)	The date/time the integration was last updated.

list

The list of ServiceNow enrichment integrations for the account. Returns at most one integration due to product limits.

Name	Datatype	Description
id	string	Base32-encoded UUID v7 (26 uppercase alphanumeric characters) identifying the integration.
name	string	The name of the integration.
cmdb_tables	array	The ServiceNow CMDB table configurations belonging to this integration. An integration must have at least 1 and at most 8 tables.
created_at	string (date-time)	The date/time the integration was created.
credentials	object	The ServiceNow credentials associated with the account, or null if no credentials have been configured. Credentials are managed through the credentials endpoints, not through this object.
description	string	An optional description of the integration.
updated_at	string (date-time)	The date/time the integration was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	integration_id		Retrieves a single ServiceNow enrichment integration by ID, including its CMDB tables, field mappings, the current sync status of each table, and credentials.<br /><br /><!-- theme: warning --><br /><br />> ### Early Access<br />> This API is in Early Access and may change at any time. Contact your PagerDuty account team to request access.<br /><br />Scoped OAuth requires: contextual_data.read<br />
list	select			Lists the ServiceNow enrichment integrations for the account, including their CMDB tables, field mappings, and credentials. Because only one integration is allowed per account, this returns at most one integration.<br /><br /><!-- theme: warning --><br /><br />> ### Early Access<br />> This API is in Early Access and may change at any time. Contact your PagerDuty account team to request access.<br /><br />Scoped OAuth requires: contextual_data.read<br />
create	insert	name, cmdb_tables		Creates a ServiceNow enrichment integration with one or more CMDB table configurations. Only one integration is allowed per account. Each CMDB table must define between 2 and 20 field mappings, and an integration may contain at most 8 tables. Credentials are managed separately through the credentials endpoints.<br /><br /><!-- theme: warning --><br /><br />> ### Early Access<br />> This API is in Early Access and may change at any time. Contact your PagerDuty account team to request access.<br /><br />Scoped OAuth requires: contextual_data.write<br />
delete	delete	integration_id		Deletes a ServiceNow enrichment integration, including all of its CMDB table configurations and their generated enrichment schemas, and disables any associated data synchronization.<br /><br /><!-- theme: warning --><br /><br />> ### Early Access<br />> This API is in Early Access and may change at any time. Contact your PagerDuty account team to request access.<br /><br />Scoped OAuth requires: contextual_data.write<br />

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
integration_id	string	Base32-encoded UUID v7 (26 uppercase alphanumeric characters) identifying the ServiceNow enrichment integration.

SELECT examples

get

Retrieves a single ServiceNow enrichment integration by ID, including its CMDB tables, field mappings, the current sync status of each table, and credentials.<br /><br /><!-- theme: warning --><br /><br />> ### Early Access<br />> This API is in Early Access and may change at any time. Contact your PagerDuty account team to request access.<br /><br />Scoped OAuth requires: contextual_data.read<br />

SELECT
id,
name,
cmdb_tables,
created_at,
credentials,
description,
updated_at
FROM pagerduty.enrichment.servicenow_integrations
WHERE integration_id = '{{ integration_id }}' -- required
;

list

Lists the ServiceNow enrichment integrations for the account, including their CMDB tables, field mappings, and credentials. Because only one integration is allowed per account, this returns at most one integration.<br /><br /><!-- theme: warning --><br /><br />> ### Early Access<br />> This API is in Early Access and may change at any time. Contact your PagerDuty account team to request access.<br /><br />Scoped OAuth requires: contextual_data.read<br />

SELECT
id,
name,
cmdb_tables,
created_at,
credentials,
description,
updated_at
FROM pagerduty.enrichment.servicenow_integrations
;

INSERT examples

create

Creates a ServiceNow enrichment integration with one or more CMDB table configurations. Only one integration is allowed per account. Each CMDB table must define between 2 and 20 field mappings, and an integration may contain at most 8 tables. Credentials are managed separately through the credentials endpoints.<br /><br /><!-- theme: warning --><br /><br />> ### Early Access<br />> This API is in Early Access and may change at any time. Contact your PagerDuty account team to request access.<br /><br />Scoped OAuth requires: contextual_data.write<br />

INSERT INTO pagerduty.enrichment.servicenow_integrations (
name,
description,
cmdb_tables
)
SELECT 
'{{ name }}' /* required */,
'{{ description }}',
'{{ cmdb_tables }}' /* required */
RETURNING
integration
;

Manifest

# Description fields are for documentation purposes
- name: servicenow_integrations
props:
  - name: name
    value: "{{ name }}"
    description: |
      The name of the integration.
  - name: description
    value: "{{ description }}"
    description: |
      An optional description of the integration.
  - name: cmdb_tables
    description: |
      The ServiceNow CMDB table configurations. An integration must have between 1 and 8 tables.
    value:
      - display_name: "{{ display_name }}"
        ci_table_name: "{{ ci_table_name }}"
        query_filter: "{{ query_filter }}"
        field_mappings: "{{ field_mappings }}"

DELETE examples

delete

Deletes a ServiceNow enrichment integration, including all of its CMDB table configurations and their generated enrichment schemas, and disables any associated data synchronization.<br /><br /><!-- theme: warning --><br /><br />> ### Early Access<br />> This API is in Early Access and may change at any time. Contact your PagerDuty account team to request access.<br /><br />Scoped OAuth requires: contextual_data.write<br />

DELETE FROM pagerduty.enrichment.servicenow_integrations
WHERE integration_id = '{{ integration_id }}' --required
;