servicenow_tables

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

Overview

Name	servicenow_tables
Type	Resource
Id	pagerduty.enrichment.servicenow_tables

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
create	insert	integration_id, cmdb_table		Adds a new ServiceNow CMDB table configuration to an existing integration. An integration may contain at most 8 tables. New tables are created with status: disabled; enable synchronization separately once the configuration has been validated.<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 />
update	update	integration_id, table_id, cmdb_table		Replaces a ServiceNow CMDB table configuration. This is a full replacement — all fields, including ci_table_name and the complete field_mappings list, must be provided. A table can only be updated while its synchronization is disabled and before its initial backfill has started.<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, table_id		Removes a ServiceNow CMDB table configuration from an integration. The table's generated enrichment schema is removed and its data synchronization is disabled.<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 />
enable	exec	integration_id, table_id		Enables data synchronization for a ServiceNow CMDB table configuration. Once enabled, the table's enrichment schema is populated with CI data from ServiceNow and kept up to date with periodic syncs. This operation is idempotent — enabling an already-enabled table succeeds.<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 />
test	exec	integration_id, table_id		Validates a ServiceNow CMDB table configuration by running a live query against ServiceNow and returning up to 10 sample records. Use this before enabling synchronization to confirm that the credentials, table name, query filter, and mapped fields are correct. Records are returned keyed by ServiceNow field name.<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 />

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.
table_id	string	Base32-encoded UUID v7 (26 uppercase alphanumeric characters) identifying the CMDB table configuration.

INSERT examples

create

Adds a new ServiceNow CMDB table configuration to an existing integration. An integration may contain at most 8 tables. New tables are created with status: disabled; enable synchronization separately once the configuration has been validated.<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_tables (
cmdb_table,
integration_id
)
SELECT 
'{{ cmdb_table }}' /* required */,
'{{ integration_id }}'
RETURNING
cmdb_table
;

Manifest

# Description fields are for documentation purposes
- name: servicenow_tables
props:
  - name: integration_id
    value: "{{ integration_id }}"
    description: Required parameter for the servicenow_tables resource.
  - name: cmdb_table
    value:
      display_name: "{{ display_name }}"
      ci_table_name: "{{ ci_table_name }}"
      query_filter: "{{ query_filter }}"
      field_mappings:
        - servicenow_field: "{{ servicenow_field }}"
          event_field: "{{ event_field }}"
          type: "{{ type }}"

UPDATE examples

update

Replaces a ServiceNow CMDB table configuration. This is a full replacement — all fields, including ci_table_name and the complete field_mappings list, must be provided. A table can only be updated while its synchronization is disabled and before its initial backfill has started.<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 />

UPDATE pagerduty.enrichment.servicenow_tables
SET 
cmdb_table = '{{ cmdb_table }}'
WHERE 
integration_id = '{{ integration_id }}' --required
AND table_id = '{{ table_id }}' --required
AND cmdb_table = '{{ cmdb_table }}' --required
RETURNING
cmdb_table;

DELETE examples

delete

Removes a ServiceNow CMDB table configuration from an integration. The table's generated enrichment schema is removed and its data synchronization is disabled.<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_tables
WHERE integration_id = '{{ integration_id }}' --required
AND table_id = '{{ table_id }}' --required
;

Lifecycle Methods

enable

Enables data synchronization for a ServiceNow CMDB table configuration. Once enabled, the table's enrichment schema is populated with CI data from ServiceNow and kept up to date with periodic syncs. This operation is idempotent — enabling an already-enabled table succeeds.<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 />

EXEC pagerduty.enrichment.servicenow_tables.enable 
@integration_id='{{ integration_id }}' --required, 
@table_id='{{ table_id }}' --required
;

test

Validates a ServiceNow CMDB table configuration by running a live query against ServiceNow and returning up to 10 sample records. Use this before enabling synchronization to confirm that the credentials, table name, query filter, and mapped fields are correct. Records are returned keyed by ServiceNow field name.<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 />

EXEC pagerduty.enrichment.servicenow_tables.test 
@integration_id='{{ integration_id }}' --required, 
@table_id='{{ table_id }}' --required
;