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.

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?

Use a Chromium-based browser to sign in to your Privileged Remote Access URL.
This URL is provided in the BeyondTrust welcome email and includes your site URL followed by /login.
From the left menu, click Management.
The Software page opens and displays by default.
At the top of the page, click Outbound Events.
The Outbound Events page displays.

How to configure outbound events

HTTP recipients

You can configure your BeyondTrust Appliance B Series to send messages to an HTTP server or to an email address when different events are triggered.

The variables sent by the B Series Appliance arrive as an HTTP POST method and can be accessed by calling the method used to retrieve POST data in your coding language. If the server does not respond with an HTTP 200 to indicate success, the B Series Appliance will re-queue the current event and retry it later.

Add new HTTP recipient, edit, delete

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

Add or edit HTTP recipient

Name

Create a unique name to help identify this outbound event.

URL

Enter the destination URL for this outbound event handler.

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

Enabled

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.

Use a CA certificate

When operating over an HTTPS connection, you must upload the certificate authority's root certificate advertised by the outbound event server.

Send custom fields

When enabled, all custom fields configured on the Custom Fields page will be included in the outbound event.

Events to send

Choose which events should trigger messages to be sent.

Retry interval

Set how often to retry a failed attempt.

Retry duration

If an event continues to retry and fail, set how long it should continue to retry before being dropped.

Email contact

Enter one or more email addresses to which notification should be sent if an error should occur.

Send email alert after

Set how long after an error the email should be sent; if the problem is resolved before this time is reached and the event succeeds, no error notification will be sent.

Resend email alerts

Set how often error emails should be sent if a failed status should continue.

Email recipients

Add new email recipient, edit, delete

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

Current status

Displays a brief status message from the SMTP relay server. As long as the B Series Appliance is able to send messages to the relay server, the status will show OK. Otherwise, review your SMTP relay server settings.

Retry duration

If an event continues to retry and fail, set how long it should continue to retry before being dropped.

Add 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.

Enabled

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.

Name

Create a unique name to help identify this outbound event.

Email address

Enter the email address to receive notice of the selected events. You can configure up to ten email addresses, separated by commas.

Require external key

If this option is checked, emails will be sent only for sessions which have an external key at the time the event occurs.

Events to send

Choose which events should trigger messages to be sent.

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.

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.