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 Name | Table Name | Description |
|---|---|---|
| Application Server | cmdb_ci_app_server | Application server configuration items |
| Audit Logs | sys_audit | Field-level change audit records |
| Audit Logs Delete | sys_audit_delete | Deleted record audit trail |
| Base Configuration Item | cmdb_ci | Core CMDB configuration items |
| Change Request | change_request | Change management requests |
| Change Task | change_task | Tasks within change requests |
| Configuration Item | cmdb_ci | Configuration item data |
| Configuration Item Relationship | cmdb_rel_ci | CMDB relationship mappings |
| Database Instance | cmdb_ci_db_instance | Database instance inventory |
| Group | sys_user_group | User groups and organizational structure |
| Incident | incident | Incident reports and tracking |
| Infrastructure Service | cmdb_ci_service | IT infrastructure services |
| Location | cmn_location | Physical and logical locations |
| Problem | problem | Problem management records |
| Server | cmdb_ci_server | Server infrastructure inventory |
| Service | cmdb_ci_service | Business and IT services |
| SysChoice | sys_choice | Choice list definitions |
| SysLog Transaction | syslog_transaction | System transaction logs |
| User | sys_user | User accounts and profiles |
| VM Hypervisor | cmdb_ci_hyper_v_instance | Virtual machine hypervisor inventory |
Prerequisites
Portal setup
- Login to your ServiceNow Instance.
- Navigate to Users
- Click on
Alloption and typeUsers. Select Users option from underSystem Security > Users and Groups.
- Click on
- Create a New User
- Fill out the details, most importantly First name, Last name and Email. Click Submit to save the info.
- Click on
Newbutton to add a new User record.
- Locate the new user
- Find the newly created user in the users list.
- Click on the UserID to open the user record details.
- 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.
- 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".
- 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.
- Navigate to System OAuth > Application Registry.
- Click New and then click Create an OAuth API endpoint for external clients.
- Enter the name of the client and click the Submit button to generate Client Secret.
- Once generated note down Client ID and Client Secret.
Configuration
| Setting | Type | Required | Description |
|---|---|---|---|
| Instance name | string | true | Instance name found in URL of your ServiceNow instance |
| Username | string | true | Your ServiceNow instance username. |
| Password | string | true | Your ServiceNow instance password. |
| Client ID | string | true | Client ID of the application created in the Application Registry while setting up OAuth. |
| Client Secret | string | true | Client ID of the application created in the Application Registry while setting up OAuth. |
| Backfill start time | string | No | The date to start fetching data from. If not specified, no past records will be fetched. |
| Stream names | array | true | List of ServiceNow table names to stream data from (e.g., ["Incident", "Location", "Application Server"]) |