Einrichten einer Webhook Beanchrichtigung
Wie Sie eine Benachrichtigung mit einem individuellen Webhook über die Verwaltungsoberfläche von EinfachGast einrichten, erfahren Sie unter diesem Link.
Changelog
Version | Änderungen |
v1.0 | Initiales Release |
Beispiel API Response
{
"event": "checkIn",
"visit": {
"id": "JEl1TMCKzcq3BUqAWJjx",
"startDate": "01.01.2024",
"startTime": "09:41",
"endDate": null,
"endTime": null,
"status": "pending",
"group": "Besucher"
"visitorName": "Maxi Mustermensch",
"statusMessage": "",
"signedInBy": {
"name": "Maria Musterfrau",
"id": "134567891283765"
"type": "Internal"
},
"signedOutBy": null,
"inputFields": [
{
"key": "Feldname X",
"value": "Test"
},
{
"key": "Feldname Y",
"value": "123"
},
{
"key": "Feldname Z",
"value": "[email protected]"
}
],
"visitorImageUrl": "https://mein.einfachgast.de/user-placeholder.png"
},
"venue": {
"address": {
"zipCode": "38000",
"country": "DE",
"city": "Musterstadt",
"street": "Musterstraße 1",
"company": "Mein Unternehmen"
},
"id": "rpKIlXxIZUzxm4fRFuZ1",
"venueLogoUrl": ""
},
}
API Referenz
event string
Der Auslöser für die gesendete Benachrichtigung.
3 Values
3 Values
checkIn
Besucheranmeldung
checkOut
Besucherabmeldung
checkInDenied
Verweigerte Anmeldung
visit object
Enthält alle Anmeldedaten, die der Besucher bei der Anmeldung angegeben hat.
13 Properties
13 Properties
id string
Eine eindeutige Kennung für die Besucheranmeldung (nicht des Besuchers).
startDate string
Datum der Anmeldung.
Format: DD-MM-YYY
startTime string
Uhrzeit der Anmeldung.
Format: HH:MM
endDate string
Datum der Abmeldung.
Format: DD-MM-YYY
endTime string
Uhrzeit der Abmeldung.
Format: HH:MM
group string
Die Bezeichnung der Besuchergruppe, über die sich der Besucher angemeldet hat.
status string
Der Status in dem sich die Besucheranmeldung befindet.
3 Values
3 Values
pending
Der Besucher ist derzeit angemeldet bzw. anwesend.
success
Der Besucher hat sich erfolgreich abgemeldet.
denied
Dem Besucher wurde die Anmeldung verweigert.
visitorName string
Der vollständige Name des Besuchers.
statusMessage string
Enthält die Nachricht an den Besucher, die ausgegeben wird, wenn eine Anmeldung verweigert wird.
signedInBy object
Enthält Informationen dazu wer den Besucher angemeldet hat.
Properties
Properties
id string
Die ID des Benutzers, Gerätes oder QR-Codes über den der Besucher angemeldet wurde.
type string
Der Kanal über welchen die Anmeldung erfolgte.
Values
Values
device
Bei Anmeldung über ein Gerät.
qrCode
Bei Anmeldung über einen QR-Code.
Internal
Bei manuellen Anmeldungen über die Verwaltungsoberfläche.
name string
Der Name des Benutzers, die Bezeichnung des Gerätes oder des QR-Codes über welchen der Besucher angemeldet wurde.
signedOutBy object
Enthält Informationen dazu wer den Besucher abgemeldet hat.
Properties
Properties
id string
Die ID des Benutzers, Gerätes oder QR-Codes über den der Besucher abgemeldet wurde. Bei einer automatischen Abmeldung durch das System: AutoCheckout
type string
Der Kanal über welchen die Abmeldung erfolgte.
Values
Values
device
Bei Abmeldung über ein Gerät.
qrCode
Bei Abmeldung über einen QR-Code.
Internal
Bei manuellen Abmeldungen über die Verwaltungsoberfläche.
AutoCheckout
Bei automatischer Abmeldung durch das System.
name string
Der Name des Benutzers, die Bezeichnung des Gerätes oder des QR-Codes über welchen der Besucher angemeldet wurde. Bei einer automatischen Abmeldung durch das System: AutoCheckout
inputFields object
Die vom Besucher bei der Anmeldung ausgefüllten Anmeldefelder.
Properties
Properties
key string
Die Bezeichnung des Anmeldefeldes.
value string
Der Wert, welcher vom Besucher im Anmeldefeld eingetragen wurde.
visitorImageUrl string
Die URL des bei der Anmeldung aufgenommenen Besucherfotos. Abhängig der eingestellten Datenschutzeinstellungen lässt sich das Bild nur für einen bestimmten Zeitraum abrufen.
venue object
Enthält die Daten des Standortes, an welchem sich der Besucher angemeldet hat.
3 Properties
3 Properties
id string
Eine eindeutige Kennung des Standortes.
address object
Enthält die Adresse des Standortes und der Unternehmensbezeichnung.
5 Properties
5 Properties
zipCode string
Die Postleitzahl des Standortes.
country string
Das Land des Standortes, angegeben im Format ISO 3166 ALPHA-2.
city string
Die Stadt des Standortes.
street string
Die Straße des Standortes.
company string
Der Name des Standortes bzw. die Unternehmensbezeichnung.
venueLogoUrl string
Eine öffentlich erreichbare URL zum Logos des Standortes.