Using Webhook Notifications in ETB Monitor

Overview

ETB Monitor allows users to integrate with external systems using webhooks. A webhook is a powerful way to receive event notifications from ETB Monitor when an alert starts or resolves.

How Webhooks Work

When an alert is triggered or resolved, ETB Monitor sends a POST request to a user-defined URL. The request contains a payload with details about the event. This enables users to automate workflows, log events, or take immediate action based on alert changes.

Setting Up Webhooks

Follow these steps to configure webhooks in ETB Monitor:

Navigate to Webhook Settings:
- Open ETB Monitor and go to Notifications.
Define Your Webhook URL:
- Click the green add button on the Notification Settings table.
- Select the site you want to that you want would like to be notified for via webhook.
- Select the priority of alerts that you want would like to be notified for via webhook.
- Select Webhook as the contact method.
- Enter the URL where ETB Monitor should send webhook notifications.
- Ensure the endpoint is publicly accessible and capable of handling POST requests.
Save Configuration:
- Click Save to activate the webhook integration.

Webhook UI.png

Webhook Payload Structure

ETB Monitor sends webhook notifications in JSON format. Below is an example payload:

{

  "id": "ee35a313-0ada-48c1-88e5-1fc9e1414fb5c",
  "sourceId": "4ea42c8f08ae4c811rd632a72f4ef1ef",
  "timestamp": 1745429609.875,
  "message": "Override Event Scheduled: Discharge @ 100 kW",
  "alertId": 85237,
  "siteName": "Soda Plant 4",
  "siteId": 141,
  "description": "Override Created",
  "priority": "low",
  "status": "resolved",
  "alertType": "override"
}

Field Descriptions

id - The unique identifier for the event in the payload. The start and resolve event for an alert will have different id, but the same alertId.
sourceId- The unique identifier for the equipment / software that is the source of the data.
alertId - The unique identifier for the alert that the event pertains to. The start and resolve event for an alert will have different IDs, but the same alertId.
siteName - The name of the site in ETB Montor.
siteId- The unique identifier for the site in ETB Monitor.
description - Description of the alert type.
message - Human readable text description of the event.
siteName - Name of the site in ETB Montor.
priority - Priority of the alert as defined in ETB Monitor. Options are high, medium, or low.
status - The current status of the alert. Options are ongoing or resolved.
alertType - A general category of the alert. Options are notPublishing, inverterInoperable, pvGenerationBelowExpected, override, essHibernating, criticalSoc, microgridMode, hardwareUnreachable, meterHealth. See Types of Alerts for information on the list of alerts supported by ETB Monitor and corresponding alertType for each.
timestamp - Time the event was generated.

Troubleshooting Webhooks

Webhook not triggering? Check the URL and ensure it is reachable.
Incorrect payload received? Validate your event selection in ETB Monitor settings.
Server not responding? Ensure your receiving system is online and configured to handle requests.

Articles in this section