Integrate using an API key to establish secure communication and automate data exchange via REST API. This simplifies integration, enabling seamless access to services and enhancing operational efficiency.

Before you begin

Role required: evt_mgmt_integration

Procedure

  1. Navigate to All > System Web Services > API Access Policies > REST API Key.
    Rest API navigation
  2. Select New.
  3. On the form, fill the fields.
    Note: The user needs to be created with the evt_mgmt_integration role. Create a new one on the sys_user table to use here to facilitate the right access.
    Table 1. API Key
    Field Description
    Name Name to identify the REST API Key
    Description Description for the REST API Key.
    Active Status of the REST API Key.
    User User associated to the REST API Key. Use the look-up icon to select the user.
    Auth Scope Option to add auth scope to manage the authority of the REST API Key.
    Token The REST API key generated by the ServiceNow AI Platform. Copy the key to use as part of the REST API call within the Header or Query parameter.
    Expiry Time after which the credential is no longer valid. Empty value means no expiration.
  4. Unlock Auth Scope and add: UserAccount.
  5. Use the form menu and select Save.

    The system generates a token and saves it in the Token field. To see the token, use the lock icon and copy the contents display below the field. This is your query parameter (or header) value when your other system sends a REST API request to ServiceNow.

    Rest API token generated in the Token field.