Events
CheckYout sendet Events als Webhooks an Ihren konfigurierten Endpoint. Hier finden Sie die Referenz aller Event-Typen mit ihren Payloads.
Übersicht
| Event-Name | Beschreibung | Status |
|---|---|---|
checkout | Gast tippt das Checkout-Sign an | Verfügbar v1.0 |
cleaning.completed | Reinigungskraft bestätigt Abschluss | Verfügbar v1.0 |
cleaning.started | Reinigungskraft beginnt mit der Arbeit | Geplant |
issue.reported | Reinigungskraft meldet ein Problem | Geplant |
checkout
Trigger
Wird ausgelöst, wenn ein Gast das physische CheckYout-Sign (QR-Code) scannt und den Checkout-Flow bestätigt. Das Event wird an alle aktiven Partner-Webhooks des Unterkunfts-Eigentümers gesendet.
Payload
| Feld | Typ | Beschreibung |
|---|---|---|
event | string | Immer "checkout" |
device_id | string | UUID des CheckYout-Geräts |
property_name | string | Name der Unterkunft |
property_city | string | null | Stadt der Unterkunft |
timestamp | string | ISO 8601 Zeitstempel |
source | string | Immer "checkyout" |
{
"event_id": "a7c3f1e2-9b4d-4e8a-b6c5-d2f1a3e4b5c6",
"event": "checkout",
"device_id": "d4f8a2b1-3c5e-4f6a-8b9c-1d2e3f4a5b6c",
"property_name": "Ferienwohnung Alpenblick",
"property_city": "Interlaken",
"timestamp": "2026-04-11T14:32:00.000Z",
"source": "checkyout"
}cleaning.completed
Trigger
Wird ausgelöst, wenn eine Reinigungskraft den Abschluss der Reinigung über den Token-Link in der WhatsApp-Nachricht bestätigt. Das Event wird an alle aktiven Partner-Webhooks des Unterkunfts-Eigentümers gesendet.
Payload
| Feld | Typ | Beschreibung |
|---|---|---|
event | string | Immer "cleaning.completed" |
device_id | string | UUID des CheckYout-Geräts |
property_name | string | Name der Unterkunft |
property_city | string | null | Stadt der Unterkunft |
cleaning_completed_at | string | ISO 8601 Zeitstempel der Reinigungsbestätigung |
timestamp | string | ISO 8601 Zeitstempel des Events |
source | string | Immer "checkyout" |
{
"event_id": "b8d4g2f3-0c5e-5f9b-c7d6-e3g2b4f5c6d7",
"event": "cleaning.completed",
"device_id": "d4f8a2b1-3c5e-4f6a-8b9c-1d2e3f4a5b6c",
"property_name": "Ferienwohnung Alpenblick",
"property_city": "Interlaken",
"cleaning_completed_at": "2026-04-11T16:45:00.000Z",
"timestamp": "2026-04-11T16:45:00.000Z",
"source": "checkyout"
}Geplante Events
Die folgenden Events sind in Planung und werden in künftigen Versionen als Partner-Webhooks verfügbar sein.
cleaning.started— Reinigungskraft beginnt mit der Arbeitissue.reported— Reinigungskraft meldet ein Problem in der Unterkunft
Benachrichtigung bei neuen Events
Abonnieren Sie unseren Changelog, um über neue Event-Typen informiert zu werden.
Nächster Schritt: Fehler-Codes