Skip to content
/
Change Enquiry State

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

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

Change Enquiry State

Request

Change the state of an enquiry in the sandbox environment, triggering its relevant event as well. You cannot go back to a previous state. If you specify QUOTED then it will trigger all eligible states before it, so in this example it would be SHORTLISTING and then finally QUOTED. Some states will be exceptions such as CLOSED which can happen in any of the previous states. This is not available in production.

Security
apiKey
Path
idstringrequired

Can be either the enquiries xeniaReference or externalId.

Example: R4E2F3A4
Bodyapplication/jsonrequired
closureReasonstring or null(enquiryStateClosureReason)

The reason for the enquiry closure. This is not always available and may be null.

Enum"PRICE""AVAILABILITY""NO_CLIENT_RESPONSE""STAY_CANCELLED_OR_POSTPONED""BOOKED_ELSEWHERE_COMPETITOR""BOOKED_ELSEWHERE_DIFFERENT_PRODUCT""DUPLICATE""NOT_AN_ENQUIRY""STAY_DOES_NOT_MEET_SITU_CRITERIA""OTHER"
Example: "STAY_CANCELLED_OR_POSTPONED"
enquiryStatestring(sandboxEnquiryStateValueUpdate)required

The new state for the enquiry. You cannot go "back" with states, only progress them forward. This is not available in production.

Enum"SHORTLISTING""QUOTED""CLOSED"
Example: "SHORTLISTING"
curl -i -X POST \
  https://docs.xenia.staysitu.com/_mock/xenia-connect/spec/external-api/v1/sandbox/enquiries/R4E2F3A4/change-state \
  -H 'Content-Type: application/json' \
  -H 'X-Api-Key: YOUR_API_KEY_HERE' \
  -d '{
    "enquiryState": "CLOSED"
  }'

Responses

Successfully triggered

Response
No content

Trigger Enquiry Webhook Event

Request

Trigger a webhook event for an enquiry in the sandbox environment. This is not available in production.

Security
apiKey
Path
idstringrequired

Can be either the enquiries xeniaReference or externalId.

Example: R4E2F3A4
Bodyapplication/jsonrequired
eventTypestring(webhookEvent)required

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"
curl -i -X POST \
  https://docs.xenia.staysitu.com/_mock/xenia-connect/spec/external-api/v1/sandbox/enquiries/R4E2F3A4/trigger-webhook-event \
  -H 'Content-Type: application/json' \
  -H 'X-Api-Key: YOUR_API_KEY_HERE' \
  -d '{
    "eventType": "ENQUIRY.CREATED"
  }'

Responses

Successfully changed state

Response
No content

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