Events

CheckYout sends events as webhooks to your configured endpoint. Below is the reference of every event type with its payload.

Overview

Event name	Description	Status
`checkout`	Guest taps the checkout sign	Available v1.0
`cleaning.completed`	Cleaner confirms completion	Available v1.0
`cleaning.started`	Cleaner starts working	Planned
`issue.reported`	Cleaner reports an issue	Planned

`checkout`

Trigger

Fires when a guest scans the physical CheckYout sign (QR code) and confirms the checkout flow. The event is sent to every active partner webhook of the property owner.

Payload

Field	Type	Description
`event`	`string`	Always `"checkout"`
`device_id`	`string`	UUID of the CheckYout device
`property_name`	`string`	Property name
`property_city`	`string \| null`	Property city
`timestamp`	`string`	ISO 8601 timestamp
`source`	`string`	Always `"checkyout"`

{
  "event_id": "a7c3f1e2-9b4d-4e8a-b6c5-d2f1a3e4b5c6",
  "event": "checkout",
  "device_id": "d4f8a2b1-3c5e-4f6a-8b9c-1d2e3f4a5b6c",
  "property_name": "Alpenblick Vacation Rental",
  "property_city": "Interlaken",
  "timestamp": "2026-04-11T14:32:00.000Z",
  "source": "checkyout"
}

`cleaning.completed`

Trigger

Fires when a cleaner confirms completion via the token link in the WhatsApp message. The event is sent to every active partner webhook of the property owner.

Payload

Field	Type	Description
`event`	`string`	Always `"cleaning.completed"`
`device_id`	`string`	UUID of the CheckYout device
`property_name`	`string`	Property name
`property_city`	`string \| null`	Property city
`cleaning_completed_at`	`string`	ISO 8601 timestamp of the cleaning confirmation
`timestamp`	`string`	ISO 8601 event timestamp
`source`	`string`	Always `"checkyout"`

{
  "event_id": "b8d4g2f3-0c5e-5f9b-c7d6-e3g2b4f5c6d7",
  "event": "cleaning.completed",
  "device_id": "d4f8a2b1-3c5e-4f6a-8b9c-1d2e3f4a5b6c",
  "property_name": "Alpenblick Vacation Rental",
  "property_city": "Interlaken",
  "cleaning_completed_at": "2026-04-11T16:45:00.000Z",
  "timestamp": "2026-04-11T16:45:00.000Z",
  "source": "checkyout"
}

Planned events

The following events are in planning and will become available as partner webhooks in upcoming versions.

cleaning.started — cleaner starts working
issue.reported — cleaner reports an issue at the property

Stay informed

Subscribe to our changelog to hear about new event types.

Next: Error codes