Configure BeyondTrust Remote Support

All of the steps in this section take place in the Remote Support /login administrative interface. Access your Remote Support interface by going to the hostname of your Remote Support instance followed by /login (, for example).

Verify that the API is Enabled

API Configuration

The Remote Support and ServiceNow Integration requires the Remote Support XML API to be enabled. This feature is used from within ServiceNow to communicate with the Remote Support APIs.

Go to /login > Management > API Configuration and verify that the Enable XML API box is checked.

Create a ServiceNow OAuth API Account

The ServiceNow API account is used from within ServiceNow to make Remote Support Command API calls.

Add API Account

  1. Go to /login > Management > API Configuration.
  2. Click Add to create a new API account and name it ServiceNow or something similar.
  3. Under Reporting API, check all options.
  4. Under Reporting API, check:
    • Allow Access to Support Session Reports and Recordings.
    • Allow Access to Presentation Session Reports and Recordings.
  5. The OAuth Client ID and OAuth Client Secret are used during the OAuth configuration step in ServiceNow. Make note of these and store them in a secure location.
  6. Click Save.


Add Outbound Events

Outbound Events

Outbound events are used to notify ServiceNow that a Remote Support Session has finished and is ready to be imported into ServiceNow.

  1. Go to /login > Management > Outbound Events.
  2. Click Add and name the new HTTP recipient ServiceNow Integration or something similar, depending on your ServiceNow instance.
  3. Set the URL to, where is the ServiceNow instance name.
  4. Scroll to Events to Send and check the Support Session End box.
  5. At the top of the page, click Save.

Set up the Custom Link

Custom Link Setup

Remote Support custom links can be configured to allow representatives to quickly access the ServiceNow Case that is associated with the session.

  1. Browse to Rep Console > Custom Links.
  2. Click Add to create a new custom link.
  3. Enter a name for the link, and then set the URL to, where is the ServiceNow instance name. If needed, you can use any of the available macros to customize the link according to your specifications.

If the customer is using External Key to store the case sys_id, then use the macro %SESSION.CUSTOM.EXTERNAL_KEY% instead.

  1. Click Save to save the new link.

Create Custom Fields

Custom Fields

BeyondTrust custom fields are used to map ServiceNow Tasks (tasks, change requests, problem records, and service catalog requests), call records, and configuration items to BeyondTrust sessions.

  1. Browse to Configuration > Custom Fields.
  2. Click Add to create a new custom field.
  3. Enter the following values:
    • Display Name: ServiceNow Case ID
    • Code Name: snow_case_id
    • Show in Rep Console: checked
  4. Click Save to save the new field.