Webhooks

BrickStor SP can be configured to emit Webhook notifications. A Webhook is a way to send a varety of events to an external service which implements a Webhook API. This event may or may not be due to direct action from BrickStor SP or the Manager.

The Webhook configuration page can be accessed via the System tab. On that tab, in the Advanced section, select Webhooks to begin configuration.

web webhook configuration

The are several types of Webhooks available for creation. The webhooks include:

  • Microsoft Teams Webhook Connector

  • Pager Duty Notifications

  • Pushover Notifications

  • Slack Webhook Connector

  • Racktop Webhook Format

The next sections include examples of how to configure each of these Webhooks services.

Microsoft Teams Webhook Connector

This Webhook allows you to send BrickStor SP notifications to the Microsoft Teams Application. First ensure you have performed the necessary steps to establish Webhook connections within Microsoft Teams.

Next, do the following on BrickStor SP:

  1. Select Create Webhook on the System tab.

  2. Enter a Name for the Webhook

  3. Enter a Description for the Webhook

  4. For Type select Microsoft Teams Webhook Connector

  5. For URL, paste in the URL provided from the Teams application.

  6. Select to turn on / off debugging to include event metadata.

  7. Choose the event types to which you would like to subscribe. You may select any number of event types

  8. Select Create

web webhook example ms teams

Pager Duty Notifications

This Webhook allows you to send BrickStor SP notifications to the PagerDuty incident response platform. First ensure you have performed the necessary steps to establish Webhook connections within PagerDuty.

Next, do the following on BrickStor SP:

  1. Select Create Webhook on the System tab.

  2. Enter a Name for the Webhook

  3. Enter a Description for the Webhook

  4. For Type, select PagerDuty Notifications

  5. For URL, paste in the URL provider from the PagerDuty platform.

  6. Enter the required Integration Key, also known as the Routing key.

  7. Optionally, you can enter a changed URL derived from the main URL as an advanced option.

  8. Choose the event types to which you would like to subscribe. You may select any number of event types

  9. Select Create

web webhook example pagerduty

Pushover Notifications

This Webhook allows you to send BrickStor SP notifications to the Pushover App for real-time notifications on your smart device. First ensure you have performed the necessary steps to establish Webhook connections within Pushover.

Next, do the following on BrickStor SP:

  1. Select Create Webhook on the System tab.

  2. Enter a Name for the Webhook

  3. Enter a Description for the Webhook

  4. For Type, select Pushover Notifications

  5. For URL, paste in the URL provider from the Pushover App.

  6. Enter the required Pushover API token.

  7. Enter the Users/Groups to receive notification.

  8. Enter the Devices to send notifications.

  9. Optionally, you can select the override default priority and sounds to play on incoming alerts and emergencies.

  10. Choose the event types to which you would like to subscribe. You may select any number of event types

  11. Select Create

web webhook example pushover

Slack Webhook Connector

This Webhook allows you to send BrickStor SP notifications to the Slack App for real-time notifications on your smart device. First ensure you have performed the necessary steps to establish Webhook connections within Slack.

Next, do the following on BrickStor SP:

  1. Select Create Webhook on the System tab.

  2. Enter a Name for the Webhook

  3. Enter a Description for the Webhook

  4. For Type, select Slack Webhook Connector

  5. For URL, paste in the URL provider from the Slack App.

  6. Choose the event types to which you would like to subscribe. You may select any number of event types

  7. Select Create

web webhook example slack

RackTop Webhook Format

This Webhook allows the user to use a generic connection to attempt to send BrickStor SP notifications to other applications not listed

Next, do the following on BrickStor SP:

  1. Select Create Webhook on the System tab.

  2. Enter a Name for the Webhook

  3. Enter a Description for the Webhook

  4. For Type, select Racktop Webhook Format

  5. For URL, paste in the URL provider from the external application.

  6. Optionally, you can provide a Username / Password / Secret for basic HTTP authentication.

  7. Choose the event types to which you would like to subscribe. You may select any number of event types

  8. Select Create

web webhook example racktop

Managing Webhooks

Once configured, Webhooks can be managed via the System tab. On that tab, in the Advanced section, select Webhooks to see established Webhooks.

web webhook management

Each Webhook can be reconfigured by selecting the gear icon in the upper left corner. This includes allowing you to make changes to which events are subscribed. The trash icon can be clicked to remove the configured Webhook. To send a test Webhook notification for a specific event, select the T icon next to that event. The test notification will be sent immediately to the configured application.