Versenden von Alarmen mit SIGNL4 REST API

Die SIGNL4 REST API ist sehr leistungsfähig und ermöglicht Ihnen zum Beispiel die Nutzung der folgenden Funktionalitäten:

- Alarme an Signl4 Teams senden

- Alarme bestätigen, schließen und mit Anmerkungen versehen

- Benutzer in den Dienst oder auf dienstfrei zu setzen

- Verwalten von Dienstplänen

- Nutzer verwalten

- Verwaltung von Kategorien

- Und vieles mehr ...

Eine ausführliche Beschreibung der SIGNL4-API-Funktionen findet Ihr  hier.

Zum Auslösen oder Senden von Alarmen habt Ihr folgende Möglichkeiten:

1. Auslösen eines Alarms: /v2/alerts

Diese Methode löst einen Alarm direkt und ohne vorheriges Ereignis aus. Sie unterstützt auch Anhänge, z. B. Bilder oder Audiodateien. Um diese Methode verwenden zu können, benötigt Ihr die Team-ID, d. h. die ID des Teams, an das Ihr den Alarm senden möchtet. Ihr könnt die Team-ID erhalten, indem Ihr die Methode /v2/alerts (Get infos of all teams) ohne Team-ID verwendt. Damit erhaltet Ihr eine Liste aller Teams mit ihren Namen und Team-IDs.

2. Ein Ereignis auslösen: /v2/events/{teamSecret}

Diese Methode entspricht der SIGNL4 inbound webhook API. Ihr könnt beliebige JSON- (Content-Type: application/json) oder sogar mehrteilige Mime-Inhalte (Content-Type: multipart/form-data) senden. Der Parameter {teamSecret) ist Ihr SIGNL4-Teamgeheimnis oder Integrationsgeheimnis. Die Methode löst ein Ereignis aus, das Sie in SIGNL4 unter Integration -> Verteilungsregeln behandeln können, um einen Alarm auszulösen.

Sample request:

POST https://connect.signl4.com/api/v2/events/{your-signl4-team-or-integration-secret}

X-S4-Api-Key: {your-signl4-api-key}

Content-Type: application/json

{

    "Title": "Test Alert",

    "Message": "This is a test.",

    "Temperature": "10",

    "X-S4-Service": "Temperature",

    "X-S4-Location": "52.3984235,13.0544149",

    "X-S4-AlertingScenario": "single_ack",

    "X-S4-Filtering": false,

    "X-S4-ExternalID": "test101",

    "X-S4-Status": "",

    "X-S4-SourceSystem": "",

    "Link": https://www.signl4.com

}

3. Ein Ereignis auslösen: /v2/events/{teamSecret} über team ID

Dies ist das Gleiche wie 2., aber anstelle des Team-Secret / Integrations-Secret verwendet Ihr die Team-ID im Parameter {teamSecret}. Dadurch wird der Alarm direkt an das entsprechende Team gesendet, ohne dass irgendwelche Verteilungsregeln verwendet werden. Ihr könnt die Team-ID wie unter 1. beschrieben ermitteln.