Skip to content

update notifications dev docs #480

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pablomendezroyo merged 1 commit into from
Jun 5, 2025
Merged

update notifications dev docs #480

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions docs/dev/notifications.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,15 @@ Each notification has a structure that includes the following fields:
```json
{
"title": "string", // e.g., "Geth Ethereum Node Sync Status"
"body": "string", // e.g., "Triggered: Geth Ethereum Node Syncing"
"body": "string", // e.g., "Geth Ethereum Node Syncing"
"category": "string", // e.g., "ethereum"
"dnpName": "string", // e.g., "geth.dnp.dappnode.eth"
"seen": false, // e.g., false
"timestamp": "string", // e.g., "2023-10-01T12:00:00Z"
"priority": "string", // e.g., "medium"
"status": "string", // e.g., "triggered"
"correlationId": "string", // e.g., "geth-eth-syncing"
"isBanner": false, // e.g., false
"callToAction": {
"title": "string", // e.g., "View Logs"
"url": "string" // e.g., "http://dappmanager.dappnode/packages/my/geth.dnp.dappnode.eth/logs"
Expand Down Expand Up @@ -66,11 +70,14 @@ curl -X POST \
"body": "This is a test notification sent with curl",
"category": "other",
"dnpName": "test.dnp.dappnode.eth",
"priority": "low",
"status": "triggered",
"callToAction": {
"title": "Hello World",
"url": "http://dappmanager.dappnode"
},
"icon": "https://gateway.ipfs.dappnode.io/ipfs/QmTVc5LQkTuaN3VxcteQ2E27pHSVJakE6XPo2FMxQTP284"
"correlationId": "testPkg-test",
"isBanner": false
}'
```

Expand Down
10 changes: 10 additions & 0 deletions docs/dev/references/notifications.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,9 @@ endpoints:
definition:
title: "Mainnet ETH Node Synced Check" # Notifications - settings: title of the notification to be configured
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
correlationId: "geth-eth-syncing" # Unique identifier for each notification endpoint
isBanner: false
priority: "medium"
alerts:
- type: custom
enabled: true
Expand All @@ -51,6 +54,9 @@ An array of configured notification endpoints. Each endpoint object includes:
- **`conditions`** (`string[]`, required): Array of string expressions representing the conditions that trigger the alert.
- **`interval`** (`string`, required): Time between checks. Must match the pattern `^[0-9]+[smhd]$` (e.g., `10s`, `5m`, `1h`, `1d`).
- **`group`** (`string`, required): Group to which the endpoint belongs.
- **`correlationId`** (`string`, required): It is the unique identifier that links triggered and resolved notifications based on their endpoint.
- **`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.
- **`priority`** (`string`, required): Priority that will be displayed on the notification. One of: `low`, `medium`, `high`, `critical`.
- **`alerts`** (`array`, required): List of alert configurations for this endpoint.

Each alert object includes:
Expand Down Expand Up @@ -105,6 +111,8 @@ The response will include the manifest with user settings for custom endpoints:
```yaml
customEndpoints:
- name: "Package updates notifications"
isBanner: false
correlationId: "dappmanager-update-pkg"
description: "Receive package updates notifications when a new version is available."
enabled: true
```
Expand All @@ -114,6 +122,8 @@ Each object includes:
- **`enabled`** (`boolean`, required): Whether the custom endpoint is active.
- **`name`** (`string`, required): Unique name for the custom metric.
- **`description`** (`string`, required): Explanation of the custom metric.
- **`correlationId`** (`string`, required): It is the unique identifier that links triggered and resolved notifications based on their endpoint.
- **`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.
- **`metric`** (`object`, optional): Metric boundaries and unit.
- **`treshold`** (`number`, optional): Threshold value to trigger alert (note: possibly a typo, intended to be `threshold`).
- **`min`** (`number`, optional): Minimum acceptable value.
Expand Down