Benachrichtigungskanäle auflisten
Gibt Benachrichtigungskanäle zurück, gescoped nach Organisation, Kunde oder Website.
GET /api/notification-channels
Query Parameter
| Parameter | Type | Required | Description |
|---|---|---|---|
organizationId | number | Nein | Scope auf Organisation |
customerId | number | Nein | Scope auf Kunde |
websiteId | number | Nein | Scope auf Website (inklusive Organisations- + Kundenkanäle) |
Beispiel (cURL)
curl -X GET "$BASE_URL/api/notification-channels?organizationId=1" \
-H "Authorization: Bearer $TOKEN" \
-H "Accept: application/json"Antwort (Response)
[
{
"id": 1,
"organizationId": 1,
"customerId": null,
"websiteId": null,
"type": "email",
"category": "direct",
"name": "Ops Email",
"config": { "email": "ops@deinkunde.com", "to": "Ops Team" },
"delaySeconds": 0,
"conditions": null,
"isActive": true,
"allowedPackageTypes": null
},
{
"id": 2,
"organizationId": 1,
"customerId": null,
"websiteId": null,
"type": "slack",
"category": "integration",
"name": "Alerts Slack Channel",
"config": { "webhookUrl": null, "hasWebhookUrl": true, "username": "Uptimeify" },
"delaySeconds": 0,
"conditions": null,
"isActive": true,
"allowedPackageTypes": null
}
]Geheimnisse innerhalb von config werden nie zurückgegeben: Eine Slack-, Discord- oder Teams-Webhook-URL kommt als null zurück, daneben steht hasWebhookUrl: true, siehe „Kanaltypen und Config" auf der Übersichtsseite der Notification Channels.
Sichtbarkeit
Ohne websiteId und ohne customerId hängt es davon ab, wer liest, welche Kanäle zurückkommen:
- Ein uneingeschränkter Leser (Organisations-Admin, globaler Admin sowie ein organisationsgebundenes Agent-Token) erhält die Kanäle auf Organisationsebene, also jene mit
customerId: nullundwebsiteId: null. - Ein kundengebundener Leser (ein
readonly-Benutzer oder eineditormit expliziten Kundenzuweisungen, dazu das für ihn ausgestellte API- oder Agent-Token) erhält zusätzlich die Kanäle seiner eigenen Kunden. Kanäle eines anderen Kunden kommen nie zurück.
Mit customerId kommen die Kanäle dieses Kunden plus die auf Organisationsebene zurück. Mit websiteId kommen zusätzlich die website-eigenen Override-Kanäle zurück.
Häufige Fehler
401 Unauthorizedwenn du nicht authentifiziert bist403 Forbiddenwenn du auf Kanäle außerhalb deines Scopes zugreifst
Benachrichtigungskanal löschen
Löscht einen Benachrichtigungskanal. War der Kanal ein Standard auf Organisationsebene, werden die Organisations-Standards automatisch synchronisiert.
Benachrichtigungskanal testen
Testet die Konfiguration eines Benachrichtigungskanals. Sendet optional eine echte Testnachricht.