Aufbau eines Webhooks

• Struktur
  • Bemerkung zu Beispielwerten
• Werte

Struktur

«Webhooks» sind einfache HTTP-Requests. Im Body dieses Requests werden Daten als JSON-Objekt mitgesendet.

Ein von der CareSuite generierter Webhook sieht wie folgt aus:

{
    "id": "8d8d52b6-ab21-4984-8abc-c5640b2e107e",
    "target": "48:88:1F:C9:B0:BA",
    "subject": "element",
    "event": "changed",
    "timestamp": "1460042371",
    "respond_to": "/api/v1/webhooks/8d8d52b6-ab21-4984-8abc-c5640b2e107e",
    "hash": "2c74049f7b3ce927cefaaa4162c98abe234f971f",
    "data": {
        "name": "Neuer Name"
    }
}

Bemerkung zu Beispielwerten

In der kompletten Dokumentation werden derzeit noch Beispiel-Werte für MAC-Adressen und Namen verwendet. Das Format dieser Werte wird sich womöglich in Zukunft ändern, da die Datenstrukturen der neuen GETS-Zentrale noch nicht definitiv bekannt sind.

Werte

id

Eindeutige Identifikation des Webhooks.

target

Identifikation des betroffenen Objekts. Je nach verwendeter GETS-Zentrale erfolgt die Identifikation über eine GETS-ID (alte Zentrale) oder über die MAC-Adresse (neue Zentrale). Beispielsweise 48:88:1F:C9:B0:BA oder 002.

subject

Art des Objekts. Beispielsweise element.

event

Art des Ereignisses. Beispielsweise created, updated, deleted.

timestamp

UNIX-Timestamp der Webhook-Generierung.

respond_to

Antwort-URL für die Quittierung des Webhooks. Die URL des API-Servers muss vor dem Wert unter respond_to noch angefügt werden, damit die komplette Antwort-URL entsteht.

hash

Signatur des Webhooks. Siehe Webhooks → Signatur.

data

Objekt mit relevanten Daten zur Änderung. Beispielsweise:

{
    "data": {
        "name": "Neuer Name",
        "status": "ACTIVE"
    }
}