Configure BeyondTrust Remote Support for the HEAT Software Integration


You must purchase this integration separately from both your Remote Support software and your HEAT Software solution. For more information, contact BeyondTrust sales.

Several configuration changes are necessary on the Secure Remote Access Appliance to integrate with HEAT Software. You must make these changes on each appliance for which you intend to create a plugin configuration, described in Configure the HEAT Plugin for Integration with BeyondTrust Remote Support.

All of the steps in this section take place in the BeyondTrust /login administrative interface. Access your Remote Support interface by going to the hostname of your Secure Remote Access Appliance followed by /login (e.g.,

Verify the API Is Enabled

API Configuration - Enable XML API

This integration requires the BeyondTrust XML API to be enabled. This feature is used by the BeyondTrust Middleware Engine to communicate with the BeyondTrust APIs.

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


Create an API Service Account - BeyondTrust 16.1 and Earlier

User Account Settings section under API Management

The API user account is used from within the integration to make BeyondTrust Command API calls to BeyondTrust.

  1. Go to /login > Users & Security > Users.
  2. Click Create New User and name it Integration or something similar.
  3. Leave Must Reset Password at Next Login unchecked.
  4. Set Password Expires On to Never Expires.
  5. Set Allowed to View Support Session Reports to View All Sessions.
  6. Check Allowed to view support session recordings.
  7. Set Allowed to View Presentation Session Reports to View All Sessions.
  8. Check Allowed to Use Reporting API and Allowed to Use Command API.
  9. Scroll to the bottom and save the account.

Create an API Service Account - BeyondTrust 16.2 and Later

Screenshot of the Add API Account page highlighting the Permissions and OAuth sections.


  1. Go to Management > API Configuration and click Add to create a new API account.
  2. Provide a name for the API account.
  3. Under Permissions, check Full Access to the Command API.
  4. For the Reporting API, check Allow Access to Support Session Reports and Recordings and Allow Access to Presentation Session Reports and Recordings.
  5. Be sure to copy the values for both the OAuth Client ID and OAuth Client Secret for use in a later step.
  6. Click Save to create the account.


Add an Outbound Event URL

Outbound Events > Add HTTP Recipient

  1. Go to /login > Management > Outbound Events.
  2. In the HTTP Recipients section, click Add and name it Integration or something similar.
  3. Enter the URL to use:
    • If using an appliance ID of "default": http://<middleware-host>:<port>/ERSPost. The default port is 8180.
    • If using an appliance ID other than "default": http://<middleware-host>:<port>/ERSPost?appliance=<appliance-id> where <middleware-host> is the hostname where the BeyondTrust Middleware Engine is installed. The default port is 8180. The <appliance-id> is an arbitrary name, but note the value used, as it is entered later in the plugin configuration. This name accepts only alphanumeric values, periods, and underscores.
  4. Scroll to Events to Send and check the following events:
    • Support Session End
    • Customer Exit Survey is Completed
    • Representative Survey is Completed
    • Someone Joins a Support Session (Optional)
  5. Click Save.
  6. Outbound Events > HTTP Recipients

  7. Now, the list of outbound events should contain the event just added. The Status column displays a value of OK if communication is working. If communication is not working, the Status column displays an error which you can use to repair communication.

Add Custom Fields

Custom Fields needing to be completed for the Heat integration.

Under Configuration > Custom Fields, add two new custom fields. Enter the following values:

Display Name Code Name Show in Rep Console
Item ID item_id Checked
Item Type item_type Checked

Add a Custom Link

BeyondTrust custom links can be configured to allow representatives to quickly access the HEAT item that is associated with the session.

Add a Custom Link

BeyondTrust 15.1 and later

  1. Browse to Rep Console > Custom Links.
  2. Click Add.
  3. Enter a name for the link, and then set the URL to where is your BeyondTrust site hostname.

The page referenced in the custom link URL does not yet exist but is created at the end of the section Configure the HEAT Plugin for Integration with BeyondTrust Remote Support.

  1. Click Save to save the new link.