Outbound events

What are outbound events?

Outbound events are notifications or alerts that are sent from the BeyondTrust system to external systems or recipients, triggered by specific actions or occurrences within the system.

There are two types of outbound events: HTTP Recipient and Email Recipient.

How are outbound events useful?

Outbound events help automate the communication of important system updates or actions to external systems or stakeholders, ensuring that relevant parties are kept informed and that necessary actions can be taken promptly.

How do I access the Outbound Events page?

1. Sign into app.beyondtrust.io.
   The BeyondTrust Home page displays.
2. From the main menu, click Privileged Remote Access > Management.
   The Managment page opens and the Software tab displays by default.
3. Click the Outbound Events tab.
   The Outbound Events tab displays.

The Outbound Events page

1. Left menu: Easy access to all pages in Privilege Remote Access, including Status, Consoles & Downloads, My Account, Configuration, Jump, Vault, Console Settings, Users & Security, Reports, Management, and Appliance pages.
2. Status: Opens the Status page.
3. Header: Change your tenant site, manage your profile, and access documentation.

4. Add: Adds a HTTP recipient.
5. HTTP Recipient column: A list of HTTP Recipient columns.

   HTTP Recipient columns

   • Name: Displays the name of the account.
   • Disabled: Displays whether the account is enabled or not. This is determined by the Enabled checkbox. If not selected, the column displays Yes, otherwise it displays No.
   • URL: Events are sent to this URL via an HTTP POST request. Enter the destination URL in the form of: http[s]://[:port][/path/to/file.ext][?queryString]. Only port 443 is supported.
   • Events to Send: Select which events should trigger messages to be sent.
   • Status: Display the status of the recipient.
   • Queued Events: Displays the number of queued events.

6. Add: Adds an Email Recipient.
7. Email Recipient column: A list of Email Recipient columns.

   Email Recipient columns

   • Name: Displays the name of the recipient.
   • Disabled: Displays whether the account is enabled or not. This is determined by the Enabled checkbox. If not selected, the column displays Yes, otherwise it displays No.
   • Email Address: Enter the email address for the account.
   • Events to Send: Select which events should trigger messages to be sent.

Add HTTP recipient

1. Sign into app.beyondtrust.io.
   The BeyondTrust Home page displays.
2. From the main menu, click Privileged Remote Access > Management.
   The Managment page opens and the Software tab displays by default.
3. Click the Outbound Events tab.
   The Outbound Events tab displays.
4. Click Add.
5. Select the Enabled checkbox to enable the event handler. Uncheck Enabled to quickly stop the messages for the event handler you set up, as in the event of planned integration testing.
6. In the Name field, enter a unique name for the destination. This is a required field.
7. In the URL field, enter a destination URL for the outbound handler in the form of: http[s]://[:port][/path/to/file.ext][?queryString]. Only port 443 is supported. Events are sent to this URL via an HTTP POST request. This is a required field.
8. For the Send Custom Fields checkbox, if selected all custom fields configured on the Configuration > Custom Fields page will be included in the outbound event.
9. For the Use a CA Certificate checkbox, this is only applicable for HTTPS connections. Upload your Issuer's CA certificate in PEM or DER format to force certificate validation. If you do not use a CA Certificate, HTTPS connections proceed without certificate validation.
10. From Events to Send, select the appropriate events for your organization. They are the following:
    • Access Session Start
    • Access Session End
    • Someone Joins an Access Session
    • Someone Leaves an Access Session
11. In the Email Contact field, enter one or more email addresses for the notifications to be sent if an error occurs. Each email address is separated by a space. Be sure to configure an SMTP relay server on the Management > Email Configuration page.
12. In the Retry Interval field, enter a value for redelivery. This specifies how often events will be retried for redelivery.
13. In the Send Email Alert After field, this specifies the length of time this destination must be in a failure state before sending an error notification email.
14. In the Retry Duration field, this specifies how long events will be retried before they are dropped.
15. In the Resend Email Alerts field, this specifies to wait at least this length of time before sending another error alert.

Edit a HTTP recipient

1. Sign into app.beyondtrust.io.
   The BeyondTrust Home page displays.
2. From the main menu, click Privileged Remote Access > Management.
   The Managment page opens and the Software tab displays by default.
3. Click the Outbound Events tab.
   The Outbound Events tab displays.
4. From the HTTP Recipient table, select the entry to edit.
5. Click the pencil to edit.
6. Make the necessary changes and click Save.

Delete a HTTP recipient

1. Sign into app.beyondtrust.io.
   The BeyondTrust Home page displays.
2. From the main menu, click Privileged Remote Access > Management.
   The Managment page opens and the Software tab displays by default.
3. Click the Outbound Events tab.
   The Outbound Events tab displays.
4. From the HTTP Recipient table, select the entry to edit.
5. Click the trash can to delete.
6. Click Yes to the confirmation dialog box.

ℹ️

Note

BeyondTrust Cloud customers must use of URLs beginning with HTTPS; only port 443 is supported.

Add an Email recipient

Before you set up your B Series Appliance to send event messages to an email address, verify that your B Series Appliance is configured to work with your SMTP relay server. Go to the Management > Email Configuration page to verify settings.

1. Sign into app.beyondtrust.io.
   The BeyondTrust Home page displays.
2. From the main menu, click Privileged Remote Access > Management.
   The Managment page opens and the Software tab displays by default.
3. Click the Outbound Events tab.
   The Outbound Events tab displays.
4. In the Email Recipient section, click Add.
5. Check Enabled to enable the event handler. Uncheck Enabled to quickly stop the messages for the event handler you set up, as in the event of planned integration testing.
6. In Name, type a unique name to identify the outbound event.
7. In Email Address, enter an email address to receive notice of the selected events. You can configure up to ten email addresses, separated by commas.
8. If the Require External Key checkbox is selected, emails are sent only for sessions which have an external key at the time the event occurs.
9. For Events to Send, select which events should trigger messages to be sent.
   1. Subject-Customize the subject of this email. Click the link below the Body field to view the macros that can used to customize the text in your emails for your purposes.
   2. Body-Customize the body of this email. Click the link below the Body field to view the macros that can used to customize the text in your emails for your purposes.
10. Click Save.

Edit an Email recipient

1. Sign into app.beyondtrust.io.
   The BeyondTrust Home page displays.
2. From the main menu, click Privileged Remote Access > Management.
   The Managment page opens and the Software tab displays by default.
3. Click the Outbound Events tab.
   The Outbound Events tab displays.
4. From the Email Recipient table, select the entry to edit.
5. Click the pencil to edit.
6. Make the necessary changes and click Save.

Delete an Email recipient

1. Sign into app.beyondtrust.io.
   The BeyondTrust Home page displays.
2. From the main menu, click Privileged Remote Access > Management.
   The Managment page opens and the Software tab displays by default.
3. Click the Outbound Events tab.
   The Outbound Events tab displays.
4. From the HTTP Recipient table, select the entry to edit.
5. Click the trash can to delete.
6. Click Yes to the confirmation dialog box.