Skip to content
/
Booking Pending

Xenia Connect API (1.0.1)

Situ's API for seamless integration with Situ's workflow.

Download OpenAPI description
spec.json
spec.yaml
Overview
Situ Technical Support
xeniaconnect@staysitu.com
Languages
Servers
Mock server
https://docs.xenia.staysitu.com/_mock/xenia-connect/spec/
Production
https://api-xenia.staysitu.com/
Sandbox
https://api-xenia-cisandbox.staysitu.com/

Bookings

Bookings are the next step in the booking journey after an enquiry has been created. Bookings are created when a quote is accepted by the client.

Webhooks

Booking PendingWebhook

Request

This event payload is sent to the eligible registered webhooks when a booking is pending confirmation.

Headers
X-Signaturestringrequired

HMAC-SHA256 signature of the request body using the webhook secret key. Use this to verify the authenticity of the webhook payload.

Example: dGhpcyBpcyBhIHNhbXBsZSBzaWduYXR1cmU=
Bodyapplication/jsonrequired
eventTypestring(webhookEvent)

Supported webhook events.

Enum"ENQUIRY.CREATED""ENQUIRY.SPECIALIST_ASSIGNED""ENQUIRY.SHORTLISTING""ENQUIRY.CLOSED""ENQUIRY.REOPENED""ENQUIRY.QUOTED""QUOTE.CREATED""QUOTE.INVALIDATED""BOOKING.PENDING""BOOKING.CLIENT_CONFIRMATION_DETAILS_SENT"
Example: "ENQUIRY.CREATED"
eventIdstring(uuid)

Unique ID of the event. This can be used as the idempotent key.

Example: "123e4567-e89b-12d3-a456-426614174000"
createdAtstring(date-time)

When the event was created within Xenia's system.

Example: "2026-01-01T15:12:56Z"
dataobject(bookingWebhookEventData)

The data object for a booking event.

application/json
{
  "eventType": "BOOKING.PENDING",
  "eventId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2026-01-02T10:30:15Z",
  "data": {
    "bookingReference": "R4E2F3A4",
    "createdAt": "2026-01-03T15:10:13Z",
    "enquiry": { … }
  }
}

Responses

The webhook was successfully received, Xenia will not try to process this again.

Booking Confirmation Details sent to PartnerWebhook

Request

This event payload is sent to the eligible registered webhooks when the booking confirmation details email is sent to the partner.

Headers
X-Signaturestringrequired

HMAC-SHA256 signature of the request body using the webhook secret key. Use this to verify the authenticity of the webhook payload.

Example: dGhpcyBpcyBhIHNhbXBsZSBzaWduYXR1cmU=
Bodyapplication/jsonrequired
eventTypestring(webhookEvent)

Supported webhook events.

Enum"ENQUIRY.CREATED""ENQUIRY.SPECIALIST_ASSIGNED""ENQUIRY.SHORTLISTING""ENQUIRY.CLOSED""ENQUIRY.REOPENED""ENQUIRY.QUOTED""QUOTE.CREATED""QUOTE.INVALIDATED""BOOKING.PENDING""BOOKING.CLIENT_CONFIRMATION_DETAILS_SENT"
Example: "ENQUIRY.CREATED"
eventIdstring(uuid)

Unique ID of the event. This can be used as the idempotent key.

Example: "123e4567-e89b-12d3-a456-426614174000"
createdAtstring(date-time)

When the event was created within Xenia's system.

Example: "2026-01-01T15:12:56Z"
dataobject(bookingWebhookEventData)

The data object for a booking event.

application/json
{
  "eventType": "BOOKING.PARTNER_CONFIRMATION_DETAILS_SENT",
  "eventId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2026-01-02T11:45:30Z",
  "data": {
    "bookingReference": "R4E2F3A4",
    "createdAt": "2026-01-03T15:10:13Z",
    "enquiry": { … }
  }
}

Responses

The webhook was successfully received, Xenia will not try to process this again.

Booking Confirmation Details sent to ClientWebhook

Request

This event payload is sent to the eligible registered webhooks when the booking confirmation details email is sent to the client.

Headers
X-Signaturestringrequired

HMAC-SHA256 signature of the request body using the webhook secret key. Use this to verify the authenticity of the webhook payload.

Example: dGhpcyBpcyBhIHNhbXBsZSBzaWduYXR1cmU=
Bodyapplication/jsonrequired
eventTypestring(webhookEvent)

Supported webhook events.

Enum"ENQUIRY.CREATED""ENQUIRY.SPECIALIST_ASSIGNED""ENQUIRY.SHORTLISTING""ENQUIRY.CLOSED""ENQUIRY.REOPENED""ENQUIRY.QUOTED""QUOTE.CREATED""QUOTE.INVALIDATED""BOOKING.PENDING""BOOKING.CLIENT_CONFIRMATION_DETAILS_SENT"
Example: "ENQUIRY.CREATED"
eventIdstring(uuid)

Unique ID of the event. This can be used as the idempotent key.

Example: "123e4567-e89b-12d3-a456-426614174000"
createdAtstring(date-time)

When the event was created within Xenia's system.

Example: "2026-01-01T15:12:56Z"
dataobject(bookingWebhookEventData)

The data object for a booking event.

application/json
{
  "eventType": "BOOKING.CLIENT_CONFIRMATION_DETAILS_SENT",
  "eventId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2026-01-02T11:45:30Z",
  "data": {
    "bookingReference": "R4E2F3A4",
    "createdAt": "2026-01-03T15:10:13Z",
    "enquiry": { … }
  }
}

Responses

The webhook was successfully received, Xenia will not try to process this again.

Booking Check-In Details SentWebhook

Request

This event payload is sent to the eligible registered webhooks when check-in details are sent for a booking.

Headers
X-Signaturestringrequired

HMAC-SHA256 signature of the request body using the webhook secret key. Use this to verify the authenticity of the webhook payload.

Example: dGhpcyBpcyBhIHNhbXBsZSBzaWduYXR1cmU=
Bodyapplication/jsonrequired
eventTypestring(webhookEvent)

Supported webhook events.

Enum"ENQUIRY.CREATED""ENQUIRY.SPECIALIST_ASSIGNED""ENQUIRY.SHORTLISTING""ENQUIRY.CLOSED""ENQUIRY.REOPENED""ENQUIRY.QUOTED""QUOTE.CREATED""QUOTE.INVALIDATED""BOOKING.PENDING""BOOKING.CLIENT_CONFIRMATION_DETAILS_SENT"
Example: "ENQUIRY.CREATED"
eventIdstring(uuid)

Unique ID of the event. This can be used as the idempotent key.

Example: "123e4567-e89b-12d3-a456-426614174000"
createdAtstring(date-time)

When the event was created within Xenia's system.

Example: "2026-01-01T15:12:56Z"
dataobject(bookingWebhookEventData)

The data object for a booking event.

application/json
{
  "eventType": "BOOKING.CHECK_IN_DETAILS_SENT",
  "eventId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2026-01-15T09:00:00Z",
  "data": {
    "bookingReference": "R4E2F3A4",
    "createdAt": "2026-01-03T15:10:13Z",
    "enquiry": { … }
  }
}

Responses

The webhook was successfully received, Xenia will not try to process this again.

Booking CancelledWebhook

Request

This event payload is sent to the eligible registered webhooks when a booking is cancelled.

Headers
X-Signaturestringrequired

HMAC-SHA256 signature of the request body using the webhook secret key. Use this to verify the authenticity of the webhook payload.

Example: dGhpcyBpcyBhIHNhbXBsZSBzaWduYXR1cmU=
Bodyapplication/jsonrequired
eventTypestring(webhookEvent)

Supported webhook events.

Enum"ENQUIRY.CREATED""ENQUIRY.SPECIALIST_ASSIGNED""ENQUIRY.SHORTLISTING""ENQUIRY.CLOSED""ENQUIRY.REOPENED""ENQUIRY.QUOTED""QUOTE.CREATED""QUOTE.INVALIDATED""BOOKING.PENDING""BOOKING.CLIENT_CONFIRMATION_DETAILS_SENT"
Example: "ENQUIRY.CREATED"
eventIdstring(uuid)

Unique ID of the event. This can be used as the idempotent key.

Example: "123e4567-e89b-12d3-a456-426614174000"
createdAtstring(date-time)

When the event was created within Xenia's system.

Example: "2026-01-01T15:12:56Z"
dataobject(bookingWebhookEventData)

The data object for a booking event.

application/json
{
  "eventType": "BOOKING.CANCELLED",
  "eventId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2026-01-03T14:20:00Z",
  "data": {
    "bookingReference": "R4E2F3A4",
    "createdAt": "2026-01-03T15:10:13Z",
    "enquiry": { … }
  }
}

Responses

The webhook was successfully received, Xenia will not try to process this again.

Enquiries

Enquiries are the start point in the booking journey. Providing as much information as possible upfront about an enquiry will increase its conversion rate and reduce touchpoints. We are constantly looking for what we can add to our set of information to make our process easier for everybody. If you have any suggestions get in contact!

OperationsWebhooks

Quotes

Quotes are the 2nd stage of the booking journey. Quotes are created when a specialist has found properties that match the enquiry requirements and send shortlisted properties to the client.

OperationsWebhooks

Sandbox Operations

Operations that only exist within the sandbox environment. These are not available in production. You can use these operations to trigger state changes in the sandbox environment to test your webhooks and other operations.

Operations

Webhook Operations

Manage your webhooks with this set of operations. The maximum limit for webhooks per environment is 5. If you need more than this please contact us.

Operations