Configure the Zendesk Plugin for Integration with BeyondTrust Remote Support
You must purchase this integration separately for both your Remote Support software and your Zendesk solution. For more information, contact BeyondTrust's Sales team.
Now that you have configured Zendesk and the B Series Appliance, deploy and configure the Zendesk plugin.
For more information on installing and working with the BeyondTrust Middleware Engine, please see the BeyondTrust Remote Support Middleware Engine Installation and Configuration document .
- Copy the provided plugin ZIP file to the server hosting the BeyondTrust Middleware Engine.
- Extract the plugin ZIP file to the Plugins folder in the directory where the BeyondTrust Middleware Engine is installed.
- Restart the BeyondTrust Middleware Engine Windows service.
- From the server, launch the middleware administration tool. The default URL is .
- The Zendesk Plugin shows in the list of plugins. Click the clipboard icon to add a new configuration.
BeyondTrust Appliance B Series
The first portion of the plugin configuration provides the necessary settings for communication between the plugin and the B Series Appliance. The configuration sections include:
- Plugin Configuration Name: Any desired value. Because multiple configurations can be created for a single plugin, allowing different environments to be targeted, provide a descriptive name to indicate how this plugin is to be used.
- Appliance Id: This can be left as Default or can be given a custom name. This value must match the value configured on the outbound event URL in the B Series Appliance. If outbound events are not being used, this value is still required, but any value may be used.
- BeyondTrust Appliance B Series Host Name: The hostname of the B Series Appliance. Do not include https:// or other URL elements.
- BeyondTrust Integration API OAuth Client ID: The client ID of the OAuth account.
- BeyondTrust Integration API OAuth Client Secret: The client secret of the OAuth account.
- Locale Used for BeyondTrust API Calls: This value directs the B Series Appliance to return session data in the specified language.
- Disabled: Enable or disable this plugin configuration.
- Allow Invalid Certificates: Leave unchecked unless there is a specific need to allow. If enabled, invalid SSL certificates are allowed in calls performed by the plugin. This would allow, for example, self-signed certificates. We do not recommend this in production environments.
- Use Non-TLS Connections: Leave unchecked unless it is the specific goal to use non-secure connections to the B Series Appliance. If checked, TLS communication is disabled altogether. If non-TLS connections are allowed, HTTP access must be enabled on the BeyondTrust /login > Management > API Configuration page. We strongly discourage using non-secure connections.
When using OAuth authentication, TLS cannot be disabled.
- Outbound Events Types: Specify which events the plugin processes when received by the middleware engine. Keep in mind that any event types selected here must also be configured to be sent in BeyondTrust. The Middleware Engine receives any events configured to be sent in BeyondTrust but passes them off to the plugin only if the corresponding event type is selected in this section.
- Support Session End
- Customer Exit Survey is Completed
- Representative Survey is Completed
- Polling Event Types: If network constraints limit connectivity between the B Series Appliance and the middleware engine such that outbound events cannot be used, an alternative is to use polling. The middleware engine regularly polls the B Series Appliance for any sessions that have ended since the last session was processed. At this time, only the Support Session End event type is supported.
One caveat to polling behavior versus the use of outbound events is that if a session has ended but the customer exit survey has not yet been submitted within the same polling interval, the customer exit survey is not processed. This does not apply to representative surveys since the session is not considered to be complete if a representative survey is still pending.
- Polling Interval: Enter only if polling is used. This determines how often the middleware engine polls the B Series Appliance for sessions that have ended.
- Retry Attempt Limit: Enter the number of retries that can be attempted if the plugin fails to process an event.
- Retry Outbound Event Types: Specify which outbound events the plugin retries if it fails to process an event.
- Retry Polling Event Types: Specify which polling events the plugin retries if it fails to process an event.
Zendesk Server Instance
The remainder of the plugin configuration provides the necessary settings for communication between the plugin and the Zendesk instance. The configuration settings include:
- Zendesk API URL: The external API services URL for the Zendesk instance (e.g.,
- Zendesk API Username: The username of the API account.
- Zendesk API Token: A token created in Zendesk for API connectivity.
After saving the configuration, click the test icon next to the new plugin configuration. No restart is needed.
On the BeyondTrust Middleware Engine server, in the <install dir>\Plugins\<integration>\Templates folder, there are multiple files ending with *.hbs. These files are used by the plugin to format the textual session report and exit surveys that are added to the corresponding ticket each time a BeyondTrust session ends or each time a survey is submitted. The templates can be edited if desired.
If changes need to be made to a template, it is a good idea to first back up the original in case the changes ever need to be reverted.
For more information on Handlebars templates, please see the Handlebars website.