> For the complete documentation index, see [llms.txt](https://chekin.gitbook.io/chekin-public-api/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://chekin.gitbook.io/chekin-public-api/api-reference/webhooks/webhook-payload-examples.md).

# Webhook payload examples

### Reservation.updated

```json
{
  "hook": {
    "id": "5b1ccc9f2ad74f95b83891641eb5e397",
    "event": "Reservation.updated",
    "target": "https://webhook.site/e34bfe23-ed7c-43fc-9dac-c7af70742fde"
  },
  "data": {
    "reservation_id": "f938798db7ac46adbbebf6f3de22c684",
    "reservation_url": "https://a.chekin.io/api/v3/reservations/f938798db7ac46adbbebf6f3de22c684/",
    "reservation_external_id": "",
    "housing_id": "fa81f98a-a59e-4c9b-866e-24602121a4c1",
    "housing_external_id": "123e4"
  }
}
```

### Guest.created

```json
{
  "hook": {
    "id": "e61ac11f1a284dfab50f40fba1dadf0c",
    "event": "Guest.created",
    "target": ""
  },
  "data": {
    "guest_id": "ee8778fbcf1d4da18ba5af22e6411bc9",
    "reservation_id": "fdb110990c4247708964b676b5c29c59",
    "guest_origin": "GUEST_APP_V2"
  }
}
```

### PoliceRegistration.complete

```json
{
  "hook": {
    "id": "ff851dc7637e4422b32c03426331fed6", 
    "event": "PoliceRegistration.complete", 
    "target": "https://core.test.net/api/webhooks/chekin/police-state-check-in/32c5e13b8498464ebfcf21d18979636a"
  },
  "data": {
    "reservation_id": "65ff60aa9b0f4678a17f27b20856a26e",
    "reservation_external_id": "8087400075619",
    "reservation_url": "https://a.chekin.io/api/v3/reservations/ba46d25ffa7045fabf5ffdeb6f8ae822/",
    "police_error_msg": ""
  }
}
```

### PoliceRegistration.error

`police_error_msg` contains the error as plain text, usually in the authority's language followed by the English version in brackets. It is an empty string when no readable text is available.

```json
{
  "hook": {
    "id": "ff851dc7637e4422b32c03426331fed6", 
    "event": "PoliceRegistration.error", 
    "target": "https://core.test.net/api/webhooks/chekin/police-state-check-in/32c5e13b8498464ebfcf21d18979636a"
  },
  "data": {
    "reservation_id": "65ff60aa9b0f4678a17f27b20856a26e",
    "reservation_external_id": "8087400075619",
    "reservation_url": "https://a.chekin.io/api/v3/reservations/ba46d25ffa7045fabf5ffdeb6f8ae822/",
    "police_error_msg": "Los campos “leader guest phone” e “invite email”: al menos uno de ellos es obligatorio para registrar la reserva. (Fields “leader guest phone” and “invite email”: at least one of them is required for booking registration.)"
  }
}
```

### Housing.identity\_verification.activated

Sent when a premium feature is turned **on** for one of your housings. Remote Access and Guidebooks use the same payload shape (`"feature"` is `remote_access` / `guidebook`), and the `*.deactivated` events are identical except `"status": "INACTIVE"`.

```json
{
  "hook": {
    "id": "af89ac4a3f8946ec9403b3ff59270d6f",
    "event": "Housing.identity_verification.activated",
    "target": "https://webhook.site/e34bfe23-ed7c-43fc-9dac-c7af70742fde"
  },
  "data": {
    "housing_id": "fa81f98a-a59e-4c9b-866e-24602121a4c1",
    "external_housing_id": "123e4",
    "account_id": "3ec03bcc5c034d8aa1403ebb9182d7c7",
    "feature": "identity_verification",
    "status": "ACTIVE",
    "occurred_at": "2026-10-02T10:26:57.704501Z"
  }
}
```

### Housing.remote\_access.deactivated

```json
{
  "hook": {
    "id": "5b1ccc9f2ad74f95b83891641eb5e397",
    "event": "Housing.remote_access.deactivated",
    "target": "https://webhook.site/e34bfe23-ed7c-43fc-9dac-c7af70742fde"
  },
  "data": {
    "housing_id": "fa81f98a-a59e-4c9b-866e-24602121a4c1",
    "external_housing_id": "123e4",
    "account_id": "3ec03bcc5c034d8aa1403ebb9182d7c7",
    "feature": "remote_access",
    "status": "INACTIVE",
    "occurred_at": "2026-10-02T10:30:12.112233Z"
  }
}
```