Skip to main content

Universal

Sync Type: Incremental

Overview

The ServiceNow Universal input fetches data from user-specified ServiceNow tables via the Table API. Unlike dedicated ServiceNow inputs that target specific tables, this universal connector allows users to select which ServiceNow tables to stream data from via configuration. Users can select multiple streams at once.

Supported Streams

The following ServiceNow tables are supported by this universal input:

Stream NameTable NameDescription
Application Servercmdb_ci_app_serverApplication server configuration items
Audit Logssys_auditField-level change audit records
Audit Logs Deletesys_audit_deleteDeleted record audit trail
Base Configuration Itemcmdb_ciCore CMDB configuration items
Change Requestchange_requestChange management requests
Change Taskchange_taskTasks within change requests
Configuration Itemcmdb_ciConfiguration item data
Configuration Item Relationshipcmdb_rel_ciCMDB relationship mappings
Database Instancecmdb_ci_db_instanceDatabase instance inventory
Groupsys_user_groupUser groups and organizational structure
IncidentincidentIncident reports and tracking
Infrastructure Servicecmdb_ci_serviceIT infrastructure services
Locationcmn_locationPhysical and logical locations
ProblemproblemProblem management records
Servercmdb_ci_serverServer infrastructure inventory
Servicecmdb_ci_serviceBusiness and IT services
SysChoicesys_choiceChoice list definitions
SysLog Transactionsyslog_transactionSystem transaction logs
Usersys_userUser accounts and profiles
VM Hypervisorcmdb_ci_hyper_v_instanceVirtual machine hypervisor inventory

Prerequisites

Portal setup

  1. Login to your ServiceNow Instance.
  2. Navigate to Users
    • Click on All option and type Users. Select Users option from under System Security > Users and Groups.
  3. Create a New User
    • Fill out the details, most importantly First name, Last name and Email. Click Submit to save the info.
    • Click on New button to add a new User record.
  4. Locate the new user
    • Find the newly created user in the users list.
    • Click on the UserID to open the user record details.
  5. Assign Roles
    • In the user record details, a new "Roles" tab will appear at the bottom.
    • Click on "Edit" under the Roles tab, which will open a new page with all available roles.
    • For the Table API, you can either add all admin roles for the tables you want to retrieve data from or add the "general" admin role to give access to all tables.
    • Save the changes.
  6. Set Password
    • Return to the user record.
    • You will see a "Set Password" button next to the update and delete button.
    • Click the Set Password button, which will open a popup.
    • Click the "Generate" button inside the popup to create a password, then click "Save Password".
  7. Instance Name
    • Note the instance name of the ServiceNow instance for use in later steps. For example, if the URL to your ServiceNow instance is https://test-demo.service-now.com, the instance name will be test-demo.

OAuth Setup

⚠️ Important: Before setting up OAuth make sure you have security_admin role.

  1. Navigate to System OAuth > Application Registry.
  2. Click New and then click Create an OAuth API endpoint for external clients.
  3. Enter the name of the client and click the Submit button to generate Client Secret.
  4. Once generated note down Client ID and Client Secret.

Configuration

SettingTypeRequiredDescription
Instance namestringtrueInstance name found in URL of your ServiceNow instance
UsernamestringtrueYour ServiceNow instance username.
PasswordstringtrueYour ServiceNow instance password.
Client IDstringtrueClient ID of the application created in the Application Registry while setting up OAuth.
Client SecretstringtrueClient ID of the application created in the Application Registry while setting up OAuth.
Backfill start timestringNoThe date to start fetching data from. If not specified, no past records will be fetched.
Stream namesarraytrueList of ServiceNow table names to stream data from (e.g., ["Incident", "Location", "Application Server"])