HTTP Webhook
Einleitung
Unser HTTP Webhook-Modul ermöglicht Dir die Integration jeder Art von benutzerdefiniertem Dienst. Das Modul sendet eine POST-Anfrage an die von Dir konfigurierten URLs, und das Provisioning kann dann vollständig von Deinem Dienst übernommen werden.
Wenn es konfiguriert ist, sendet das Modul mit jeder Anfrage ein HTTP Authorization Bearer Token.
Installation
Keine
Alle Requests von dem Modul:
Methode: POST Payload:
Schlüssel | Beschreibung |
|---|---|
productHosting | ProductHosting-Objekt |
event | Das Event, z.B. create, lock, unlock, delete, |
options | Nur bei create, ein assoc-Array mit den Produktoptione |
Die create-Response von der API wird in dem Hosting gespeichert. Sollte die JSON-Response den Schlüssel "message" enthalten, wird diese gelogged und in der Administration angezeigt.
Request-Besonderheit: Status Abfrage
Methode: GET (!) Erwartete Rückgabe: JSON Response mit den Schlüsseln:
Schlüssel | Beschreibung |
|---|---|
statusString | Der String, der im Kundenbereich angezeigt wird. z.B. "Online" oder "Offline" |
badgeColor | Die Bootstrap-Farbe der Badge, die angezeigt wird. z.B. "danger" oder "success" |
additional | Optional - Zusätzliche Daten im Array-Format, welche in der Storefront zur Verfügung stehen |
Wenn statusString nicht definiert ist, wird standardmäßig der Status "Aktiv" in grüner Farbe zurückgegeben.
Request-Besonderheit: Overview Abfrage
Methode: GET (!) Erwartete Rückgabe: JSON Response mit den Schlüsseln:
Schlüssel | Beschreibung |
|---|---|
html | HTML, welches auf der Übersicht des Hostings im Kundenbereich angezeigt wird. |
Wenn html nicht definiert ist, wird im Kundenbereich nichts angezeigt.