Einrichtung eines Webhooks in Pocsag Südtirol

Aktuell kann die Einstellungen nur mittels Verwaltungskonto durchgeführt werden.

Um einen Webhook in Pocsag Südtirol einzurichten, sind die folgenden Schritte zu befolgen:

  • Zum jeweiligen Mitglied gewechselt werden.
  • Auf der linken Seite auf die „Weltkugel“ bei Webhooks klicken.

 

 

1. Webhook-URL eintragen:

Die URL des Webhook-Endpunkts in das entsprechende Feld in der Webhook-Konfigurationsmaske von Pocsag Südtirol eintragen. Dies ist die URL, an die die Alarmmeldungen gesendet werden.
 

2. Authentifizierung einstellen:

Es gibt drei Möglichkeiten, die Authentifizierung für den Webhook festzulegen:

  1. Keine Authentifizierung (nicht empfohlen): Wenn keine Authentifizierung verwendet werden soll, die Felder für Benutzername, Passwort und Token leer lassen.
  2. Basic Auth: Um Basic Authentication zu verwenden, den Benutzernamen und das Passwort in die entsprechenden Felder eintragen. Der Benutzername und das Passwort werden dann im HTTP-Header der Anforderung als Base64-codiertes String-Paar (username:password) gesendet.
  3. Bearer Token: Bei Verwendung eines Bearer Tokens die Felder für Benutzername und Passwort leer lassen und das Token in das entsprechende Feld eintragen. Dieses Token wird dann im HTTP-Header der Anforderung unter Authorization als Bearer <Token> gesendet.

 

3. Datentyp wählen:

Es gibt drei Datentypen, welche gesendet werden können. Der richtige Datentyp sollte entsprechend den Anforderungen des Webhook-Empfängers gewählt werden:

  • json: Für die Übertragung von JSON-Daten (z.B. {"id": 1, "name": "test1"}).
  • form-data: Für die Übertragung von Daten im multipart/form-data-Format, häufig verwendet für Dateien und Formulare.
  • x-www-form-urlencoded: Für die Übertragung von URL-kodierten Formulardaten.

 

4. Zusätzliche Headers:

Optional können zusätzliche HTTP-Header definiert werden. Diese müssen im JSON-Format angegeben werden.

  • Beispiel für zusätzliche Headers:
    [
      { "header_name": "X-Custom-Header 1", "header_value": "application/json" },
      { "header_name": "X-Custom-Header 2", "header_value": "custom_value" }
    ]

 

5. Standardinhalt mit zusätzlichem Inhalt:

Der Standardinhalt kann mit zusätzlichem Inhalt erweitert werden. Die Einstellung auf „erweitern“ setzen.
 

6. Zusätzlicher Inhalt (Body):

Optional kann zusätzlicher Inhalt im Body der HTTP-Anfrage angegeben werden. Dieser zusätzliche Inhalt muss im JSON-Format angegeben werden.

  • Beispiel für zusätzlichen Inhalt (Body):
    { "id": 1, "name": "test1" }

 

7. Test

Nachdem der Webhook eingetragen ist, kann über die „Play“ taste dieser getestet werden.
 

8. Aktivierung bei der Schleife:

Um das Aufrufen der Webhook-URL zu aktivieren, muss diese bei der Schleife unter sonstige Einstellungen aktiviert werden.

  • Hierzu bei der jeweiligen Schleife auf der rechten Seite beim Menüpunkt die Schleifen-Details öffnen und Webhook aktivieren.

Objektstruktur:

Das Objekt, das vom Webhook gesendet wird, hat die folgende Struktur:

Felder:

  • bezirk: Name des Bezirks. (Text)
  • organisation: Name der Organisation. (Text)
  • schleife: Schleifennummer oder Bezeichnung. (Text)
  • alarmstufe: Alarmstufe. (Nummer, optional – kann „null“ sein)
  • stichwort: Hauptstichwort. (Text, optional – kann „null“ sein)
  • unterstichwort: Unterstichwort. (Text, optional – kann „null“ sein)
  • datum: Datum und Uhrzeit des Alarms. (Text, Format: „yyyy-MM-ddTHH:mm:ss“)
  • typ: Typ der Nachricht („Alarm“ oder „Nachricht“).

Beispiel:

Ein Beispiel-JSON könnte so aussehen:

{
„bezirk“: „Bozen“,
„organisation“: „Pocsag Südtirol“,
„schleife“: „Sammelruf“,
„alarmstufe“: 2,
„stichwort“: „Brand Mittel“,
„unterstichwort“: „Gebäude“,
„datum“: „2024-08-09T14:30:00“,
„typ“: „Alarm“
}

 

Wichtiger Hinweis zum Support

Da Pocsag Südtirol als kostenloser Dienst angeboten wird, kann kein individueller Support für die Einrichtung und Nutzung des Webhooks geleistet werden. Es werden lediglich Log-Dateien zur Verfügung gestellt, um bei eventuellen Problemen zu unterstützen. Diese Logs können genutzt werden, um Fehler selbstständig zu identifizieren und zu beheben. Bitte berücksichtigen, dass es keine weitere technische Unterstützung oder detaillierte Fehleranalyse geben wird.

Gemäß AGB 4.2 übernehmen wir keine Garantie für die einwandfreie Funktion des Dienstes und haften nicht für Ausfälle, Fehlfunktionen oder daraus resultierende Schäden, einschließlich Einbruch oder Diebstahl.

Ist der Artikel hilfreich?

Comments are closed.