Webhook Event Payload Examples

Below are example payloads you might receive from Hostex OpenAPI Webhooks for different events. Each payload includes relevant information that your application can use to process the event.

`reservation_created`

{
  "event": "reservation_created",
  "reservation_code": "string",
  "stay_code": "string",
  "timestamp":"2024-01-01T00:00:00Z"
}

`reservation_updated`

{
  "event": "reservation_updated",
  "reservation_code": "string",
  "stay_code": "string",
  "timestamp":"2024-01-01T00:00:00Z"
}

{
  "event": "reservation_updated",
  "sub_event": "arrival_and_departure_time_updated",
  "reservation_code": "string",
  "stay_code": "string",
  "timestamp":"2024-01-01T00:00:00Z"
}

{
  "event": "reservation_updated",
  "sub_event": "rates_updated",
  "reservation_code": "string",
  "stay_code": "string",
  "timestamp":"2024-01-01T00:00:00Z"
}

{
  "event": "reservation_updated",
  "sub_event": "lock_code_updated",
  "reservation_code": "string",
  "stay_code": "string",
  "timestamp":"2024-01-01T00:00:00Z"
}

{
  "event": "reservation_updated",
  "sub_event": "lock_code_deleted",
  "reservation_code": "string",
  "stay_code": "string",
  "timestamp":"2024-01-01T00:00:00Z"
}

{
  "event": "reservation_updated",
  "sub_event": "check_in_details_updated",
  "reservation_code": "string",
  "stay_code": "string",
  "timestamp":"2024-01-01T00:00:00Z"
}

`property_availability_updated`

{
  "event": "property_availability_updated",
  "property_id": 10000,
  "availabilities": [
    {
      "date": "2019-01-01",
      "available": true
    },
    {
      "date": "2019-01-02",
      "available": true
    }
  ],
  "timestamp":"2024-01-01T00:00:00Z"
}

`listing_calendar_updated`

{
  "event": "listing_calendar_updated",
  "channel_type": "airbnb",
  "listing_id": "string",
  "start_date": "2019-01-01",
  "end_date": "2019-02-01",
  "timestamp":"2024-01-01T00:00:00Z"
}

`message_created`

{
  "event": "message_created",
  "conversation_id": "string",
  "message_id": "string",
  "timestamp":"2024-01-01T00:00:00Z"
}

`review_created`

{
  "event": "review_created",
  "reservation_code": "string",
  "stay_code": "string",
  "timestamp":"2024-01-01T00:00:00Z"
}

`review_updated`

{
  "event": "review_updated",
  "reservation_code": "string",
  "stay_code": "string",
  "timestamp":"2024-01-01T00:00:00Z"
}