SAP Open Connectors

ServiceNow Events

SAP Open Connectors supports events via polling or webhooks depending on the API provider. For more information about our Events framework, see Events Overview.

Supported Events and Resources

SAP Open Connectors supports polling events for ServiceNow. After receiving an event, SAP Open Connectors standardizes the payload and sends an event to the configured callback URL of your authenticated connector instance.

You can set up polling for the events resource. You can also copy the events configuration to poll other resources. See Configure Polling Through API for more information.

Note: Unless configured for a specific time zone, polling occurs in UTC.

Configure Polling Through the UI

To configure polling through the UI, follow the same steps to authenticate a connector instance, and then turn on events. Select the resources to poll, and then click Create Instance. For more information, see Authenticate an Connector Instance with Events (UI) or the connector-specific authentication topic.

Configure Polling Through API

Use the /instances endpoint to authenticate with ServiceNow and create a connector instance with polling enabled.

Note: The endpoint returns a connector instance token and id upon successful completion. Retain the token and id for all subsequent requests involving this connector instance.

To authenticate a connector instance with polling:

  1. Construct a JSON body as shown below (see Parameters):

        "code": "<AUTHORIZATION_GRANT_CODE>"
        "username": "<USERNAME>",
        "password": "<PASSWORD>",
        "servicenow.subdomain": "<SUBDOMAIN>",
        "event.notification.enabled": true,
        "event.notification.callback.url": "",
        "event.poller.refresh_interval": "<minutes>",
            "url": "/hubs/helpdesk/accounts?where=sys_updated_on>'${gmtDate:yyyy-MM-dd'T'HH:mm:ss}'",
                "idField": "sys_id",
                "datesConfiguration": {
                    "updatedDateField": "sys_updated_on",
                    "updatedDateFormat": "yyyy-MM-dd HH:mm:ss",
                    "createdDateField": "sys_created_on",
                    "createdDateFormat": "yyyy-MM-dd HH:mm:ss"
  2. Call the following, including the JSON body you constructed in the previous step:

    POST /instances
    Note: Make sure that you include the User and Organization keys in the header. For more information, see Authorization Headers, Organization Secret, and User Secret.
  3. Locate the token and id in the response and save them for all future requests using the connector instance.

Example JSON with Polling

instance JSON with polling events enabled:

    "username": "username",
    "password": "******",
    "servicenow.subdomain": "dev12345" ,
        "url":"/hubs/finance/customers?where=lastModifiedDate>='${date:yyyy-MM-dd'T'HH:mm:ss'Z'}' and attributes='created_at,updated_at",


API parameters not shown in SAP Open Connectors are in code formatting.

ParameterDescriptionData Type
keyThe connector key.
The name for the connector instance created during authentication.string
Your ServiceNow user name.
Your ServiceNow password.string
The ServiceNow Subdomain
This is the part of your URL that is specific to your organization, for example in domain12345 is the subdomainstring
Events Enabled
Optional. Identifies that events are enabled for the connector instance.
Default: false.
Event Notification Callback URL
The URL where you want SAP Open Connectors to send the events.string
Event poller refresh interval (mins)
A number in minutes to identify how often the poller should check for changes.number
Configure Polling
Optional*. Configuration parameters for polling.JSON object
accountsThe configuration of the customers resource.JSON object
The url to query for updates to the resource.String
ID Field
The field in the resource that is used to uniquely identify it.String
Advanced Filtering
Configuration parameters for dates in pollingJSON Object
Updated Date Field
The field that identifies an updated object.String
Updated Date Format
The date format of the field that identifies an updated object.String
Created Date Field
The field that identifies a created object.String
Created Date Format
The date format of the field that identifies a created object.String
tagsOptional. User-defined tags to further identify the instance.string