API Configuration: Enable the XML API and Configure Custom Fields

Management > API Configuration

API :: Configuration

Enable XML API

Choose to enable the Bomgar XML API, allowing you to run reports and issue commands such as starting or transferring sessions from external applications, as well as to automatically back up your software configuration.

Note: Only the Command, Reporting, and Client Scripting API calls are enabled/disabled by this setting. Other API calls are configured under Public Portals. See the API Programmer's Guide for more details.

Allow HTTP Access to XML API

Note: This feature is available only to customers who own an on-premises Bomgar Appliance. Bomgar Cloud customers do not have access to this feature.

By default, access to the API is SSL-encrypted. However, you can choose to allow unencrypted HTTP access. It is highly recommended that HTTP access be disallowed as a security best practice.

Enable Real-time State API

Choose to enable real-time reporting on representative activity, whether they are in a support session or not, with metrics such as time available, busy, in concurrent sessions, etc. See the API Programmer's Guide for more details.

Enable State Archive API

Choose to enable the state archive API to download logs of the Bomgar Appliance's state and of events that occurred on a given date. See the API Programmer's Guide for more details.

API :: Custom Fields

Create custom API fields to gather information about your customer, enabling you to more deeply integrate Bomgar with your existing programs. Custom fields must be used in combination with the Bomgar API. See the API Programmer's Guide for more details.

Create New Field, Edit, Delete

Create a new object, modify an existing object, or remove an existing object.

API :: Custom Fields :: Add or Edit

Display Name

Create a unique name to help identify this object. This name is displayed in the representative console as part of the session details.

Code Name

Set a code name for integration purposes. If you do not set a code name, one will be created automatically.

Show in Representative Console

If you check Show in Representative Console, this field and its values will be visible wherever custom session details are displayed in the representative console.