You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/dev/references/notifications.md
+10Lines changed: 10 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -33,6 +33,9 @@ endpoints:
33
33
definition:
34
34
title: "Mainnet ETH Node Synced Check"# Notifications - settings: title of the notification to be configured
35
35
description: "Check if the Mainnet ETH Node is synced. You will receive a notification if the node is syncing and another one when it is synced."# Notifications - settings: description of the notification to be configured
36
+
correlationId: "geth-eth-syncing"# Unique identifier for each notification endpoint
37
+
isBanner: false
38
+
priority: "medium"
36
39
alerts:
37
40
- type: custom
38
41
enabled: true
@@ -51,6 +54,9 @@ An array of configured notification endpoints. Each endpoint object includes:
51
54
- **`conditions`** (`string[]`, required): Array of string expressions representing the conditions that trigger the alert.
52
55
- **`interval`** (`string`, required): Time between checks. Must match the pattern `^[0-9]+[smhd]$` (e.g., `10s`, `5m`, `1h`, `1d`).
53
56
- **`group`** (`string`, required): Group to which the endpoint belongs.
57
+
- **`correlationId`** (`string`, required): It is the unique identifier that links triggered and resolved notifications based on their endpoint.
58
+
- **`isBanner`** (`boolean`, required): Boolean that controls whether a banner displaying the notification appears at the top of the DAppManager UI. Should be set to `true` only for relevant notifications.
59
+
- **`priority`** (`string`, required): Priority that will be displayed on the notification. One of: `low`, `medium`, `high`, `critical`.
54
60
- **`alerts`** (`array`, required): List of alert configurations for this endpoint.
55
61
56
62
Each alert object includes:
@@ -105,6 +111,8 @@ The response will include the manifest with user settings for custom endpoints:
105
111
```yaml
106
112
customEndpoints:
107
113
- name: "Package updates notifications"
114
+
isBanner: false
115
+
correlationId: "dappmanager-update-pkg"
108
116
description: "Receive package updates notifications when a new version is available."
109
117
enabled: true
110
118
```
@@ -114,6 +122,8 @@ Each object includes:
114
122
- **`enabled`** (`boolean`, required): Whether the custom endpoint is active.
115
123
- **`name`** (`string`, required): Unique name for the custom metric.
116
124
- **`description`** (`string`, required): Explanation of the custom metric.
125
+
- **`correlationId`** (`string`, required): It is the unique identifier that links triggered and resolved notifications based on their endpoint.
126
+
- **`isBanner`** (`boolean`, required): Boolean that controls whether a banner displaying the notification appears at the top of the DAppManager UI. Should be set to `true` only for relevant notifications.
117
127
- **`metric`** (`object`, optional): Metric boundaries and unit.
118
128
- **`treshold`** (`number`, optional): Threshold value to trigger alert (note: possibly a typo, intended to be `threshold`).
0 commit comments