notifications

GET /v1/notification-connections

Connected destinations and the routing matrix.

Alle notifications Endpunkte

Authentifizierung

Senden Sie einen API-Schlüssel als Bearer-Token. Dieser Endpunkt gibt in der Spezifikation keine spezifische Berechtigung an. Versehen Sie Ihren Schlüssel daher mit den minimal erforderlichen Rechten und prüfen Sie die Antwort, anstatt Annahmen zu treffen.

Hier kommt Ihre Organisations-ID hin

Dieser Endpunkt akzeptiert org_id als Abfrageparameter. Lassen Sie ihn weg, erfasst der Aufruf Ihren gesamten Mandanten-Unterbaum; übergeben Sie ihn, um den Aufruf auf eine Organisation einzugrenzen.

Die ID Ihrer Organisation finden Sie im Dashboard auf dem Bildschirm für API-Schlüssel direkt neben dem Schlüssel selbst. Sie ist bei jedem Ihrer Aufrufe dieselbe.

Ausprobieren

Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem Dashboard.

curl -X GET https://api.zinndigital.com/v1/notification-connections \
  -H "Authorization: Bearer zdk_live_…"

Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole

Details

Every destination this organisation has connected - e-mail addresses, Slack channels, Telegram chats - with the full grid of which notification types go to each. The grid is returned COMPLETE rather than as the stored deviations. Only the cells a human switched OFF are persisted (absence means enabled), so a client that had to infer "everything not listed is on" would be re-implementing that default - and two implementations of one decision is how a customer ends up on a ladder nobody chose.

Parameter

NameTypErforderlichWas es ist
org_id (query)stringNeinThe organization to act on. Omitted resolves to your own ONLY when you belong to exactly one organisation; a principal in more than one must name it, or the call is refused `422…

Antwort

NameTypErforderlichWas es ist
connectionsNotificationConnection[]Nein
topicsobject[]NeinThe routing units. TOPICS, not notification types - the matrix used to address a type enum that no notification template declares, so no cell of it could ever have addressed a m…