{"items":[{"type":"link","label":"Xenia Connect API","link":"/xenia-connect/spec","routeSlug":"/xenia-connect/spec","content":{"contentType":"overview","meta":{"name":"Xenia Connect API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"spec.json","url":"/_bundle/xenia-connect/spec.json?download"},{"kind":"download","label":"spec.yaml","url":"/_bundle/xenia-connect/spec.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"email","title":"Situ Technical Support","email":"xeniaconnect@staysitu.com","label":"xeniaconnect@staysitu.com","withCopyButton":true,"copyContent":"xeniaconnect@staysitu.com"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/xenia-connect/spec","description":"Mock server","isMockServer":true},{"description":"Production","url":"https://api-xenia.staysitu.com"},{"description":"Sandbox","url":"https://api-xenia-cisandbox.staysitu.com"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Xenia Connect API (1.0.1)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"Situ's API for seamless integration with Situ's workflow."}],"sectionId":"/"}],"sectionId":"/"}]}]}},{"type":"group","label":"Bookings","link":"/xenia-connect/spec/bookings","routeSlug":"/xenia-connect/spec/bookings","items":[{"label":"Booking Pending","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/xenia-connect/spec/bookings/webhookbookingpendingevent","routeSlug":"/xenia-connect/spec/bookings/webhookbookingpendingevent","metadata":{"seo":{"title":"Booking Pending","description":"This event payload is sent to the eligible registered webhooks when a booking is pending confirmation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhookBookingPendingEvent","name":"Booking Pending","isWebhook":true,"pointer":"/paths/booking-pending-event/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Booking Pending","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This event payload is sent to the eligible registered webhooks when a booking is pending confirmation."},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature","in":"header","schemaId":"schema_0","description":"HMAC-SHA256 signature of the request body using the webhook secret key. Use this to verify the authenticity of the webhook payload.","required":true}],"pointer":"/paths/booking-pending-event/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/bookingWebhookPayload","exampleIds":["paths/booking-pending-event/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/bookingWebhookPayload","exampleIds":["paths/booking-pending-event/post/requestBody/content/application~1json/example"],"pointer":"/paths/booking-pending-event/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"booking-pending-event","servers":[{"url":"/_mock/xenia-connect/spec","description":"Mock server","isMockServer":true},{"url":"https://api-xenia.staysitu.com","description":"Production"},{"url":"https://api-xenia-cisandbox.staysitu.com","description":"Sandbox"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature","in":"header","required":true,"example":"dGhpcyBpcyBhIHNhbXBsZSBzaWduYXR1cmU=","schemaId":"schema_0"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/bookingWebhookPayload","exampleIds":["paths/booking-pending-event/post/requestBody/content/application~1json/example"]}},"responseCodes":["204","400","500","503"],"pointer":"booking-pending-event","href":"bookings/webhookbookingpendingevent","openApiOperationId":"webhookBookingPendingEvent","summary":"Booking Pending"},"isWebhook":true,"hideReplay":false,"schemaId":"components/schemas/bookingWebhookPayload","exampleIds":["paths/booking-pending-event/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/bookingWebhookPayload","exampleIds":["paths/booking-pending-event/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"The webhook was successfully received, Xenia will not try to process this again."},{"code":"400","description":"The webhook was not received successfully, Xenia will retry this webhook up to 5 times."},{"code":"500","description":"The webhook was not received successfully, Xenia will retry this webhook up to 5 times."},{"code":"503","description":"The webhook was not received successfully, Xenia will retry this webhook up to 5 times."}],"pointer":"/paths/booking-pending-event/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bookings/webhookbookingpendingevent"}],"panels":[]}]},"httpPath":"booking-pending-event"},{"label":"Booking Confirmation Details sent to Partner","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/xenia-connect/spec/bookings/webhookbookingconfirmationdetailssenttopartnerevent","routeSlug":"/xenia-connect/spec/bookings/webhookbookingconfirmationdetailssenttopartnerevent","metadata":{"seo":{"title":"Booking Confirmation Details sent to Partner","description":"This event payload is sent to the eligible registered webhooks when the booking confirmation details email is sent to the partner."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhookBookingConfirmationDetailsSentToPartnerEvent","name":"Booking Confirmation Details sent to Partner","isWebhook":true,"pointer":"/paths/booking-partner-confirmation-details-sent-event/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Booking Confirmation Details sent to Partner","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This event payload is sent to the eligible registered webhooks when the booking confirmation details email is sent to the partner."},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature","in":"header","schemaId":"schema_0","description":"HMAC-SHA256 signature of the request body using the webhook secret key. Use this to verify the authenticity of the webhook payload.","required":true}],"pointer":"/paths/booking-partner-confirmation-details-sent-event/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/bookingWebhookPayload","exampleIds":["paths/booking-partner-confirmation-details-sent-event/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/bookingWebhookPayload","exampleIds":["paths/booking-partner-confirmation-details-sent-event/post/requestBody/content/application~1json/example"],"pointer":"/paths/booking-partner-confirmation-details-sent-event/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"booking-partner-confirmation-details-sent-event","servers":[{"url":"/_mock/xenia-connect/spec","description":"Mock server","isMockServer":true},{"url":"https://api-xenia.staysitu.com","description":"Production"},{"url":"https://api-xenia-cisandbox.staysitu.com","description":"Sandbox"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature","in":"header","required":true,"example":"dGhpcyBpcyBhIHNhbXBsZSBzaWduYXR1cmU=","schemaId":"schema_0"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/bookingWebhookPayload","exampleIds":["paths/booking-partner-confirmation-details-sent-event/post/requestBody/content/application~1json/example"]}},"responseCodes":["204","400","500","503"],"pointer":"booking-partner-confirmation-details-sent-event","href":"bookings/webhookbookingconfirmationdetailssenttopartnerevent","openApiOperationId":"webhookBookingConfirmationDetailsSentToPartnerEvent","summary":"Booking Confirmation Details sent to Partner"},"isWebhook":true,"hideReplay":false,"schemaId":"components/schemas/bookingWebhookPayload","exampleIds":["paths/booking-partner-confirmation-details-sent-event/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/bookingWebhookPayload","exampleIds":["paths/booking-partner-confirmation-details-sent-event/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"The webhook was successfully received, Xenia will not try to process this again."},{"code":"400","description":"The webhook was not received successfully, Xenia will retry this webhook up to 5 times."},{"code":"500","description":"The webhook was not received successfully, Xenia will retry this webhook up to 5 times."},{"code":"503","description":"The webhook was not received successfully, Xenia will retry this webhook up to 5 times."}],"pointer":"/paths/booking-partner-confirmation-details-sent-event/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bookings/webhookbookingconfirmationdetailssenttopartnerevent"}],"panels":[]}]},"httpPath":"booking-partner-confirmation-details-sent-event"},{"label":"Booking Confirmation Details sent to Client","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/xenia-connect/spec/bookings/webhookbookingconfirmationdetailssenttoclientevent","routeSlug":"/xenia-connect/spec/bookings/webhookbookingconfirmationdetailssenttoclientevent","metadata":{"seo":{"title":"Booking Confirmation Details sent to Client","description":"This event payload is sent to the eligible registered webhooks when the booking confirmation details email is sent to the client."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhookBookingConfirmationDetailsSentToClientEvent","name":"Booking Confirmation Details sent to Client","isWebhook":true,"pointer":"/paths/booking-client-confirmation-details-sent-event/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Booking Confirmation Details sent to Client","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This event payload is sent to the eligible registered webhooks when the booking confirmation details email is sent to the client."},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature","in":"header","schemaId":"schema_0","description":"HMAC-SHA256 signature of the request body using the webhook secret key. Use this to verify the authenticity of the webhook payload.","required":true}],"pointer":"/paths/booking-client-confirmation-details-sent-event/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/bookingWebhookPayload","exampleIds":["paths/booking-client-confirmation-details-sent-event/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/bookingWebhookPayload","exampleIds":["paths/booking-client-confirmation-details-sent-event/post/requestBody/content/application~1json/example"],"pointer":"/paths/booking-client-confirmation-details-sent-event/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"booking-client-confirmation-details-sent-event","servers":[{"url":"/_mock/xenia-connect/spec","description":"Mock server","isMockServer":true},{"url":"https://api-xenia.staysitu.com","description":"Production"},{"url":"https://api-xenia-cisandbox.staysitu.com","description":"Sandbox"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature","in":"header","required":true,"example":"dGhpcyBpcyBhIHNhbXBsZSBzaWduYXR1cmU=","schemaId":"schema_0"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/bookingWebhookPayload","exampleIds":["paths/booking-client-confirmation-details-sent-event/post/requestBody/content/application~1json/example"]}},"responseCodes":["204","400","500","503"],"pointer":"booking-client-confirmation-details-sent-event","href":"bookings/webhookbookingconfirmationdetailssenttoclientevent","openApiOperationId":"webhookBookingConfirmationDetailsSentToClientEvent","summary":"Booking Confirmation Details sent to Client"},"isWebhook":true,"hideReplay":false,"schemaId":"components/schemas/bookingWebhookPayload","exampleIds":["paths/booking-client-confirmation-details-sent-event/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/bookingWebhookPayload","exampleIds":["paths/booking-client-confirmation-details-sent-event/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"The webhook was successfully received, Xenia will not try to process this again."},{"code":"400","description":"The webhook was not received successfully, Xenia will retry this webhook up to 5 times."},{"code":"500","description":"The webhook was not received successfully, Xenia will retry this webhook up to 5 times."},{"code":"503","description":"The webhook was not received successfully, Xenia will retry this webhook up to 5 times."}],"pointer":"/paths/booking-client-confirmation-details-sent-event/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bookings/webhookbookingconfirmationdetailssenttoclientevent"}],"panels":[]}]},"httpPath":"booking-client-confirmation-details-sent-event"},{"label":"Booking Check-In Details Sent","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/xenia-connect/spec/bookings/webhookbookingcheckindetailssentevent","routeSlug":"/xenia-connect/spec/bookings/webhookbookingcheckindetailssentevent","metadata":{"seo":{"title":"Booking Check-In Details Sent","description":"This event payload is sent to the eligible registered webhooks when check-in details are sent for a booking."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhookBookingCheckInDetailsSentEvent","name":"Booking Check-In Details Sent","isWebhook":true,"pointer":"/paths/booking-check-in-details-sent-event/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Booking Check-In Details Sent","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This event payload is sent to the eligible registered webhooks when check-in details are sent for a booking."},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature","in":"header","schemaId":"schema_0","description":"HMAC-SHA256 signature of the request body using the webhook secret key. Use this to verify the authenticity of the webhook payload.","required":true}],"pointer":"/paths/booking-check-in-details-sent-event/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/bookingWebhookPayload","exampleIds":["paths/booking-check-in-details-sent-event/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/bookingWebhookPayload","exampleIds":["paths/booking-check-in-details-sent-event/post/requestBody/content/application~1json/example"],"pointer":"/paths/booking-check-in-details-sent-event/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"booking-check-in-details-sent-event","servers":[{"url":"/_mock/xenia-connect/spec","description":"Mock server","isMockServer":true},{"url":"https://api-xenia.staysitu.com","description":"Production"},{"url":"https://api-xenia-cisandbox.staysitu.com","description":"Sandbox"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature","in":"header","required":true,"example":"dGhpcyBpcyBhIHNhbXBsZSBzaWduYXR1cmU=","schemaId":"schema_0"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/bookingWebhookPayload","exampleIds":["paths/booking-check-in-details-sent-event/post/requestBody/content/application~1json/example"]}},"responseCodes":["204","400","500","503"],"pointer":"booking-check-in-details-sent-event","href":"bookings/webhookbookingcheckindetailssentevent","openApiOperationId":"webhookBookingCheckInDetailsSentEvent","summary":"Booking Check-In Details Sent"},"isWebhook":true,"hideReplay":false,"schemaId":"components/schemas/bookingWebhookPayload","exampleIds":["paths/booking-check-in-details-sent-event/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/bookingWebhookPayload","exampleIds":["paths/booking-check-in-details-sent-event/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"The webhook was successfully received, Xenia will not try to process this again."},{"code":"400","description":"The webhook was not received successfully, Xenia will retry this webhook up to 5 times."},{"code":"500","description":"The webhook was not received successfully, Xenia will retry this webhook up to 5 times."},{"code":"503","description":"The webhook was not received successfully, Xenia will retry this webhook up to 5 times."}],"pointer":"/paths/booking-check-in-details-sent-event/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bookings/webhookbookingcheckindetailssentevent"}],"panels":[]}]},"httpPath":"booking-check-in-details-sent-event"},{"label":"Booking Cancelled","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/xenia-connect/spec/bookings/webhookbookingcancelledevent","routeSlug":"/xenia-connect/spec/bookings/webhookbookingcancelledevent","metadata":{"seo":{"title":"Booking Cancelled","description":"This event payload is sent to the eligible registered webhooks when a booking is cancelled."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhookBookingCancelledEvent","name":"Booking Cancelled","isWebhook":true,"pointer":"/paths/booking-cancelled-event/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Booking Cancelled","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This event payload is sent to the eligible registered webhooks when a booking is cancelled."},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature","in":"header","schemaId":"schema_0","description":"HMAC-SHA256 signature of the request body using the webhook secret key. Use this to verify the authenticity of the webhook payload.","required":true}],"pointer":"/paths/booking-cancelled-event/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/bookingWebhookPayload","exampleIds":["paths/booking-cancelled-event/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/bookingWebhookPayload","exampleIds":["paths/booking-cancelled-event/post/requestBody/content/application~1json/example"],"pointer":"/paths/booking-cancelled-event/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"booking-cancelled-event","servers":[{"url":"/_mock/xenia-connect/spec","description":"Mock server","isMockServer":true},{"url":"https://api-xenia.staysitu.com","description":"Production"},{"url":"https://api-xenia-cisandbox.staysitu.com","description":"Sandbox"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature","in":"header","required":true,"example":"dGhpcyBpcyBhIHNhbXBsZSBzaWduYXR1cmU=","schemaId":"schema_0"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/bookingWebhookPayload","exampleIds":["paths/booking-cancelled-event/post/requestBody/content/application~1json/example"]}},"responseCodes":["204","400","500","503"],"pointer":"booking-cancelled-event","href":"bookings/webhookbookingcancelledevent","openApiOperationId":"webhookBookingCancelledEvent","summary":"Booking Cancelled"},"isWebhook":true,"hideReplay":false,"schemaId":"components/schemas/bookingWebhookPayload","exampleIds":["paths/booking-cancelled-event/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/bookingWebhookPayload","exampleIds":["paths/booking-cancelled-event/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"The webhook was successfully received, Xenia will not try to process this again."},{"code":"400","description":"The webhook was not received successfully, Xenia will retry this webhook up to 5 times."},{"code":"500","description":"The webhook was not received successfully, Xenia will retry this webhook up to 5 times."},{"code":"503","description":"The webhook was not received successfully, Xenia will retry this webhook up to 5 times."}],"pointer":"/paths/booking-cancelled-event/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bookings/webhookbookingcancelledevent"}],"panels":[]}]},"httpPath":"booking-cancelled-event"}],"content":{"contentType":"group","meta":{"name":"bookings"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bookings","showPageActions":true},{"nodeType":"markdoc","content":"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."}],"panels":[{"children":[{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"booking-pending-event","summary":"Booking Pending","prefix":{"name":"post","color":"post"},"badges":[],"link":"/bookings/webhookbookingpendingevent","deprecated":false},{"title":"booking-partner-confirmation-details-sent-event","summary":"Booking Confirmation Details sent to Partner","prefix":{"name":"post","color":"post"},"badges":[],"link":"/bookings/webhookbookingconfirmationdetailssenttopartnerevent","deprecated":false},{"title":"booking-client-confirmation-details-sent-event","summary":"Booking Confirmation Details sent to Client","prefix":{"name":"post","color":"post"},"badges":[],"link":"/bookings/webhookbookingconfirmationdetailssenttoclientevent","deprecated":false},{"title":"booking-check-in-details-sent-event","summary":"Booking Check-In Details Sent","prefix":{"name":"post","color":"post"},"badges":[],"link":"/bookings/webhookbookingcheckindetailssentevent","deprecated":false},{"title":"booking-cancelled-event","summary":"Booking Cancelled","prefix":{"name":"post","color":"post"},"badges":[],"link":"/bookings/webhookbookingcancelledevent","deprecated":false}]}]}]}]}},{"type":"group","label":"Enquiries","link":"/xenia-connect/spec/enquiries","routeSlug":"/xenia-connect/spec/enquiries","items":[{"label":"Create a new enquiry","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/xenia-connect/spec/enquiries/createenquiry","routeSlug":"/xenia-connect/spec/enquiries/createenquiry","metadata":{"seo":{"title":"Create a new enquiry","description":"Create a new enquiry for Situ to begin the quoting process on."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createEnquiry","name":"Create a new enquiry","isWebhook":false,"pointer":"/paths/~1external-api~1v1~1enquiries/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new enquiry","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new enquiry for Situ to begin the quoting process on."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-Api-Key"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/createEnquiryRequest"}},"schemaId":"components/schemas/createEnquiryRequest","pointer":"/paths/~1external-api~1v1~1enquiries/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/external-api/v1/enquiries","servers":[{"url":"/_mock/xenia-connect/spec","description":"Mock server","isMockServer":true},{"url":"https://api-xenia.staysitu.com","description":"Production"},{"url":"https://api-xenia-cisandbox.staysitu.com","description":"Sandbox"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/createEnquiryRequest"}},"responseCodes":["201","400","401","403","500"],"pointer":"/external-api/v1/enquiries","href":"enquiries/createenquiry","openApiOperationId":"createEnquiry","summary":"Create a new enquiry"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/xenia-connect/spec","description":"Mock server","isMockServer":true},{"url":"https://api-xenia.staysitu.com","description":"Production"},{"url":"https://api-xenia-cisandbox.staysitu.com","description":"Sandbox"}],"schemaId":"components/schemas/createEnquiryRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/createEnquiryRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The created enquiry object.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/enquiryResponse"}},"schemaId":"components/schemas/enquiryResponse"},{"code":"400","description":"Validation errors have occurred, e.g. missing required fields or invalid data types.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/validationErrorsResponse","exampleIds":["paths/~1external-api~1v1~1enquiries/post/responses/400/content/application~1problem+json/example"]}},"schemaId":"components/schemas/validationErrorsResponse","exampleIds":["paths/~1external-api~1v1~1enquiries/post/responses/400/content/application~1problem+json/example"]},{"code":"401","description":"Failed to authenticate the request. This may be because the token is invalid or expired."},{"code":"403","description":"Failed to authorize the request. This may be because you not have the required permissions."},{"code":"500","description":"An error occurred on the server, you may be able to find more detail inside the error object","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/problemDetails"}},"schemaId":"components/schemas/problemDetails"}],"pointer":"/paths/~1external-api~1v1~1enquiries/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/enquiryResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/enquiryResponse"}}},{"code":"400","schemaId":"components/schemas/validationErrorsResponse","exampleIds":["paths/~1external-api~1v1~1enquiries/post/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/validationErrorsResponse","exampleIds":["paths/~1external-api~1v1~1enquiries/post/responses/400/content/application~1problem+json/example"]}}},{"code":"401"},{"code":"403"},{"code":"500","schemaId":"components/schemas/problemDetails","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/problemDetails"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enquiries/createenquiry"}],"panels":[]}]},"httpPath":"/external-api/v1/enquiries"},{"label":"Get an enquiry","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/xenia-connect/spec/enquiries/getenquiry","routeSlug":"/xenia-connect/spec/enquiries/getenquiry","metadata":{"seo":{"title":"Get an enquiry","description":"Get an enquiry"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEnquiry","name":"Get an enquiry","isWebhook":false,"pointer":"/paths/~1external-api~1v1~1enquiries~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get an enquiry","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-Api-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Can be either the enquiries "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"xeniaReference"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"externalId"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"required":true,"example":"R4E2F3A4"}],"pointer":"/paths/~1external-api~1v1~1enquiries~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/external-api/v1/enquiries/{id}","servers":[{"url":"/_mock/xenia-connect/spec","description":"Mock server","isMockServer":true},{"url":"https://api-xenia.staysitu.com","description":"Production"},{"url":"https://api-xenia-cisandbox.staysitu.com","description":"Sandbox"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"R4E2F3A4","schemaId":"schema_1"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/external-api/v1/enquiries/{id}","href":"enquiries/getenquiry","openApiOperationId":"getEnquiry","summary":"Get an enquiry"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/xenia-connect/spec","description":"Mock server","isMockServer":true},{"url":"https://api-xenia.staysitu.com","description":"Production"},{"url":"https://api-xenia-cisandbox.staysitu.com","description":"Sandbox"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The enquiry object","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/enquiryResponse"}},"schemaId":"components/schemas/enquiryResponse"},{"code":"401","description":"Failed to authenticate the request. This may be because the token is invalid or expired."},{"code":"403","description":"Failed to authorize the request. This may be because you not have the required permissions."},{"code":"404","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The enquiry was not found. This may be because the enquiry has been deleted or the ID provided is invalid. The provided error status will be "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"RESOURCE_NOT_FOUND"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/problemDetails","exampleIds":["paths/~1external-api~1v1~1enquiries~1{id}/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"components/schemas/problemDetails","exampleIds":["paths/~1external-api~1v1~1enquiries~1{id}/get/responses/404/content/application~1problem+json/example"]}],"pointer":"/paths/~1external-api~1v1~1enquiries~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/enquiryResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/enquiryResponse"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/problemDetails","exampleIds":["paths/~1external-api~1v1~1enquiries~1{id}/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/problemDetails","exampleIds":["paths/~1external-api~1v1~1enquiries~1{id}/get/responses/404/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enquiries/getenquiry"}],"panels":[]}]},"httpPath":"/external-api/v1/enquiries/{id}"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"Enquiry Created","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/xenia-connect/spec/enquiries/webhookenquirycreatedevent","routeSlug":"/xenia-connect/spec/enquiries/webhookenquirycreatedevent","metadata":{"seo":{"title":"Enquiry Created","description":"This event payload is sent to the eligible registered webhooks when a new enquiry is created."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhookEnquiryCreatedEvent","name":"Enquiry Created","isWebhook":true,"pointer":"/paths/enquiry-created-event/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Enquiry Created","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This event payload is sent to the eligible registered webhooks when a new enquiry is created."},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature","in":"header","schemaId":"schema_0","description":"HMAC-SHA256 signature of the request body using the webhook secret key. Use this to verify the authenticity of the webhook payload.","required":true}],"pointer":"/paths/enquiry-created-event/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/enquiryWebhookPayload","exampleIds":["paths/enquiry-created-event/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/enquiryWebhookPayload","exampleIds":["paths/enquiry-created-event/post/requestBody/content/application~1json/example"],"pointer":"/paths/enquiry-created-event/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"enquiry-created-event","servers":[{"url":"/_mock/xenia-connect/spec","description":"Mock server","isMockServer":true},{"url":"https://api-xenia.staysitu.com","description":"Production"},{"url":"https://api-xenia-cisandbox.staysitu.com","description":"Sandbox"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature","in":"header","required":true,"example":"dGhpcyBpcyBhIHNhbXBsZSBzaWduYXR1cmU=","schemaId":"schema_0"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/enquiryWebhookPayload","exampleIds":["paths/enquiry-created-event/post/requestBody/content/application~1json/example"]}},"responseCodes":["204","400","500","503"],"pointer":"enquiry-created-event","href":"enquiries/webhookenquirycreatedevent","openApiOperationId":"webhookEnquiryCreatedEvent","summary":"Enquiry Created"},"isWebhook":true,"hideReplay":false,"schemaId":"components/schemas/enquiryWebhookPayload","exampleIds":["paths/enquiry-created-event/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/enquiryWebhookPayload","exampleIds":["paths/enquiry-created-event/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"The webhook was successfully received, Xenia will not try to process this again."},{"code":"400","description":"The webhook was not received successfully, Xenia will retry this webhook up to 5 times."},{"code":"500","description":"The webhook was not received successfully, Xenia will retry this webhook up to 5 times."},{"code":"503","description":"The webhook was not received successfully, Xenia will retry this webhook up to 5 times."}],"pointer":"/paths/enquiry-created-event/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enquiries/webhookenquirycreatedevent"}],"panels":[]}]},"httpPath":"enquiry-created-event"},{"label":"Enquiry Shortlisting","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/xenia-connect/spec/enquiries/webhookenquiryshortlistingevent","routeSlug":"/xenia-connect/spec/enquiries/webhookenquiryshortlistingevent","metadata":{"seo":{"title":"Enquiry Shortlisting","description":"This event payload is sent to the eligible registered webhooks when a specialist starts shortlisting properties for an enquiry."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhookEnquiryShortlistingEvent","name":"Enquiry Shortlisting","isWebhook":true,"pointer":"/paths/enquiry-shortlisting-event/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Enquiry Shortlisting","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This event payload is sent to the eligible registered webhooks when a specialist starts shortlisting properties for an enquiry."},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature","in":"header","schemaId":"schema_0","description":"HMAC-SHA256 signature of the request body using the webhook secret key. Use this to verify the authenticity of the webhook payload.","required":true}],"pointer":"/paths/enquiry-shortlisting-event/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/enquiryWebhookPayload","exampleIds":["paths/enquiry-shortlisting-event/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/enquiryWebhookPayload","exampleIds":["paths/enquiry-shortlisting-event/post/requestBody/content/application~1json/example"],"pointer":"/paths/enquiry-shortlisting-event/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"enquiry-shortlisting-event","servers":[{"url":"/_mock/xenia-connect/spec","description":"Mock server","isMockServer":true},{"url":"https://api-xenia.staysitu.com","description":"Production"},{"url":"https://api-xenia-cisandbox.staysitu.com","description":"Sandbox"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature","in":"header","required":true,"example":"dGhpcyBpcyBhIHNhbXBsZSBzaWduYXR1cmU=","schemaId":"schema_0"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/enquiryWebhookPayload","exampleIds":["paths/enquiry-shortlisting-event/post/requestBody/content/application~1json/example"]}},"responseCodes":["204","400","500","503"],"pointer":"enquiry-shortlisting-event","href":"enquiries/webhookenquiryshortlistingevent","openApiOperationId":"webhookEnquiryShortlistingEvent","summary":"Enquiry Shortlisting"},"isWebhook":true,"hideReplay":false,"schemaId":"components/schemas/enquiryWebhookPayload","exampleIds":["paths/enquiry-shortlisting-event/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/enquiryWebhookPayload","exampleIds":["paths/enquiry-shortlisting-event/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"The webhook was successfully received, Xenia will not try to process this again."},{"code":"400","description":"The webhook was not received successfully, Xenia will retry this webhook up to 5 times."},{"code":"500","description":"The webhook was not received successfully, Xenia will retry this webhook up to 5 times."},{"code":"503","description":"The webhook was not received successfully, Xenia will retry this webhook up to 5 times."}],"pointer":"/paths/enquiry-shortlisting-event/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enquiries/webhookenquiryshortlistingevent"}],"panels":[]}]},"httpPath":"enquiry-shortlisting-event"},{"label":"Enquiry Specialist Assigned","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/xenia-connect/spec/enquiries/webhookenquiryspecialistassignedevent","routeSlug":"/xenia-connect/spec/enquiries/webhookenquiryspecialistassignedevent","metadata":{"seo":{"title":"Enquiry Specialist Assigned","description":"This event payload is sent to the eligible registered webhooks when a specialist is assigned to an enquiry."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhookEnquirySpecialistAssignedEvent","name":"Enquiry Specialist Assigned","isWebhook":true,"pointer":"/paths/enquiry-specialist-assigned-event/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Enquiry Specialist Assigned","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This event payload is sent to the eligible registered webhooks when a specialist is assigned to an enquiry."},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature","in":"header","schemaId":"schema_0","description":"HMAC-SHA256 signature of the request body using the webhook secret key. Use this to verify the authenticity of the webhook payload.","required":true}],"pointer":"/paths/enquiry-specialist-assigned-event/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/enquiryWebhookPayload","exampleIds":["paths/enquiry-specialist-assigned-event/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/enquiryWebhookPayload","exampleIds":["paths/enquiry-specialist-assigned-event/post/requestBody/content/application~1json/example"],"pointer":"/paths/enquiry-specialist-assigned-event/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"enquiry-specialist-assigned-event","servers":[{"url":"/_mock/xenia-connect/spec","description":"Mock server","isMockServer":true},{"url":"https://api-xenia.staysitu.com","description":"Production"},{"url":"https://api-xenia-cisandbox.staysitu.com","description":"Sandbox"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature","in":"header","required":true,"example":"dGhpcyBpcyBhIHNhbXBsZSBzaWduYXR1cmU=","schemaId":"schema_0"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/enquiryWebhookPayload","exampleIds":["paths/enquiry-specialist-assigned-event/post/requestBody/content/application~1json/example"]}},"responseCodes":["204","400","500","503"],"pointer":"enquiry-specialist-assigned-event","href":"enquiries/webhookenquiryspecialistassignedevent","openApiOperationId":"webhookEnquirySpecialistAssignedEvent","summary":"Enquiry Specialist Assigned"},"isWebhook":true,"hideReplay":false,"schemaId":"components/schemas/enquiryWebhookPayload","exampleIds":["paths/enquiry-specialist-assigned-event/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/enquiryWebhookPayload","exampleIds":["paths/enquiry-specialist-assigned-event/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"The webhook was successfully received, Xenia will not try to process this again."},{"code":"400","description":"The webhook was not received successfully, Xenia will retry this webhook up to 5 times."},{"code":"500","description":"The webhook was not received successfully, Xenia will retry this webhook up to 5 times."},{"code":"503","description":"The webhook was not received successfully, Xenia will retry this webhook up to 5 times."}],"pointer":"/paths/enquiry-specialist-assigned-event/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enquiries/webhookenquiryspecialistassignedevent"}],"panels":[]}]},"httpPath":"enquiry-specialist-assigned-event"},{"label":"Enquiry Quoted","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/xenia-connect/spec/enquiries/webhookenquiryquotedevent","routeSlug":"/xenia-connect/spec/enquiries/webhookenquiryquotedevent","metadata":{"seo":{"title":"Enquiry Quoted","description":"This event payload is sent to the eligible registered webhooks when a quote is sent for an enquiry."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhookEnquiryQuotedEvent","name":"Enquiry Quoted","isWebhook":true,"pointer":"/paths/enquiry-quoted-event/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Enquiry Quoted","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This event payload is sent to the eligible registered webhooks when a quote is sent for an enquiry."},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature","in":"header","schemaId":"schema_0","description":"HMAC-SHA256 signature of the request body using the webhook secret key. Use this to verify the authenticity of the webhook payload.","required":true}],"pointer":"/paths/enquiry-quoted-event/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/enquiryWebhookPayload","exampleIds":["paths/enquiry-quoted-event/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/enquiryWebhookPayload","exampleIds":["paths/enquiry-quoted-event/post/requestBody/content/application~1json/example"],"pointer":"/paths/enquiry-quoted-event/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"enquiry-quoted-event","servers":[{"url":"/_mock/xenia-connect/spec","description":"Mock server","isMockServer":true},{"url":"https://api-xenia.staysitu.com","description":"Production"},{"url":"https://api-xenia-cisandbox.staysitu.com","description":"Sandbox"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature","in":"header","required":true,"example":"dGhpcyBpcyBhIHNhbXBsZSBzaWduYXR1cmU=","schemaId":"schema_0"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/enquiryWebhookPayload","exampleIds":["paths/enquiry-quoted-event/post/requestBody/content/application~1json/example"]}},"responseCodes":["204","400","500","503"],"pointer":"enquiry-quoted-event","href":"enquiries/webhookenquiryquotedevent","openApiOperationId":"webhookEnquiryQuotedEvent","summary":"Enquiry Quoted"},"isWebhook":true,"hideReplay":false,"schemaId":"components/schemas/enquiryWebhookPayload","exampleIds":["paths/enquiry-quoted-event/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/enquiryWebhookPayload","exampleIds":["paths/enquiry-quoted-event/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"The webhook was successfully received, Xenia will not try to process this again."},{"code":"400","description":"The webhook was not received successfully, Xenia will retry this webhook up to 5 times."},{"code":"500","description":"The webhook was not received successfully, Xenia will retry this webhook up to 5 times."},{"code":"503","description":"The webhook was not received successfully, Xenia will retry this webhook up to 5 times."}],"pointer":"/paths/enquiry-quoted-event/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enquiries/webhookenquiryquotedevent"}],"panels":[]}]},"httpPath":"enquiry-quoted-event"},{"label":"Enquiry Closed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/xenia-connect/spec/enquiries/webhookenquiryclosedevent","routeSlug":"/xenia-connect/spec/enquiries/webhookenquiryclosedevent","metadata":{"seo":{"title":"Enquiry Closed","description":"This event payload is sent to the eligible registered webhooks when an enquiry is closed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhookEnquiryClosedEvent","name":"Enquiry Closed","isWebhook":true,"pointer":"/paths/enquiry-closed-event/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Enquiry Closed","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This event payload is sent to the eligible registered webhooks when an enquiry is closed."},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature","in":"header","schemaId":"schema_0","description":"HMAC-SHA256 signature of the request body using the webhook secret key. Use this to verify the authenticity of the webhook payload.","required":true}],"pointer":"/paths/enquiry-closed-event/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/enquiryWebhookPayload","exampleIds":["paths/enquiry-closed-event/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/enquiryWebhookPayload","exampleIds":["paths/enquiry-closed-event/post/requestBody/content/application~1json/example"],"pointer":"/paths/enquiry-closed-event/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"enquiry-closed-event","servers":[{"url":"/_mock/xenia-connect/spec","description":"Mock server","isMockServer":true},{"url":"https://api-xenia.staysitu.com","description":"Production"},{"url":"https://api-xenia-cisandbox.staysitu.com","description":"Sandbox"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature","in":"header","required":true,"example":"dGhpcyBpcyBhIHNhbXBsZSBzaWduYXR1cmU=","schemaId":"schema_0"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/enquiryWebhookPayload","exampleIds":["paths/enquiry-closed-event/post/requestBody/content/application~1json/example"]}},"responseCodes":["204","400","500","503"],"pointer":"enquiry-closed-event","href":"enquiries/webhookenquiryclosedevent","openApiOperationId":"webhookEnquiryClosedEvent","summary":"Enquiry Closed"},"isWebhook":true,"hideReplay":false,"schemaId":"components/schemas/enquiryWebhookPayload","exampleIds":["paths/enquiry-closed-event/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/enquiryWebhookPayload","exampleIds":["paths/enquiry-closed-event/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"The webhook was successfully received, Xenia will not try to process this again."},{"code":"400","description":"The webhook was not received successfully, Xenia will retry this webhook up to 5 times."},{"code":"500","description":"The webhook was not received successfully, Xenia will retry this webhook up to 5 times."},{"code":"503","description":"The webhook was not received successfully, Xenia will retry this webhook up to 5 times."}],"pointer":"/paths/enquiry-closed-event/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enquiries/webhookenquiryclosedevent"}],"panels":[]}]},"httpPath":"enquiry-closed-event"},{"label":"Enquiry Reopened","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/xenia-connect/spec/enquiries/webhookenquiryreopenedevent","routeSlug":"/xenia-connect/spec/enquiries/webhookenquiryreopenedevent","metadata":{"seo":{"title":"Enquiry Reopened","description":"This event payload is sent to the eligible registered webhooks when a closed enquiry is reopened."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhookEnquiryReopenedEvent","name":"Enquiry Reopened","isWebhook":true,"pointer":"/paths/enquiry-reopened-event/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Enquiry Reopened","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This event payload is sent to the eligible registered webhooks when a closed enquiry is reopened."},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature","in":"header","schemaId":"schema_0","description":"HMAC-SHA256 signature of the request body using the webhook secret key. Use this to verify the authenticity of the webhook payload.","required":true}],"pointer":"/paths/enquiry-reopened-event/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/enquiryWebhookPayload","exampleIds":["paths/enquiry-reopened-event/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/enquiryWebhookPayload","exampleIds":["paths/enquiry-reopened-event/post/requestBody/content/application~1json/example"],"pointer":"/paths/enquiry-reopened-event/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"enquiry-reopened-event","servers":[{"url":"/_mock/xenia-connect/spec","description":"Mock server","isMockServer":true},{"url":"https://api-xenia.staysitu.com","description":"Production"},{"url":"https://api-xenia-cisandbox.staysitu.com","description":"Sandbox"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature","in":"header","required":true,"example":"dGhpcyBpcyBhIHNhbXBsZSBzaWduYXR1cmU=","schemaId":"schema_0"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/enquiryWebhookPayload","exampleIds":["paths/enquiry-reopened-event/post/requestBody/content/application~1json/example"]}},"responseCodes":["204","400","500","503"],"pointer":"enquiry-reopened-event","href":"enquiries/webhookenquiryreopenedevent","openApiOperationId":"webhookEnquiryReopenedEvent","summary":"Enquiry Reopened"},"isWebhook":true,"hideReplay":false,"schemaId":"components/schemas/enquiryWebhookPayload","exampleIds":["paths/enquiry-reopened-event/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/enquiryWebhookPayload","exampleIds":["paths/enquiry-reopened-event/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"The webhook was successfully received, Xenia will not try to process this again."},{"code":"400","description":"The webhook was not received successfully, Xenia will retry this webhook up to 5 times."},{"code":"500","description":"The webhook was not received successfully, Xenia will retry this webhook up to 5 times."},{"code":"503","description":"The webhook was not received successfully, Xenia will retry this webhook up to 5 times."}],"pointer":"/paths/enquiry-reopened-event/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enquiries/webhookenquiryreopenedevent"}],"panels":[]}]},"httpPath":"enquiry-reopened-event"}],"content":{"contentType":"group","meta":{"name":"enquiries"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Enquiries","showPageActions":true},{"nodeType":"markdoc","content":"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!"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/external-api/v1/enquiries","summary":"Create a new enquiry","prefix":{"name":"post","color":"post"},"badges":[],"link":"/enquiries/createenquiry","deprecated":false},{"title":"/external-api/v1/enquiries/{id}","summary":"Get an enquiry","prefix":{"name":"get","color":"get"},"badges":[],"link":"/enquiries/getenquiry","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"enquiry-created-event","summary":"Enquiry Created","prefix":{"name":"post","color":"post"},"badges":[],"link":"/enquiries/webhookenquirycreatedevent","deprecated":false},{"title":"enquiry-shortlisting-event","summary":"Enquiry Shortlisting","prefix":{"name":"post","color":"post"},"badges":[],"link":"/enquiries/webhookenquiryshortlistingevent","deprecated":false},{"title":"enquiry-specialist-assigned-event","summary":"Enquiry Specialist Assigned","prefix":{"name":"post","color":"post"},"badges":[],"link":"/enquiries/webhookenquiryspecialistassignedevent","deprecated":false},{"title":"enquiry-quoted-event","summary":"Enquiry Quoted","prefix":{"name":"post","color":"post"},"badges":[],"link":"/enquiries/webhookenquiryquotedevent","deprecated":false},{"title":"enquiry-closed-event","summary":"Enquiry Closed","prefix":{"name":"post","color":"post"},"badges":[],"link":"/enquiries/webhookenquiryclosedevent","deprecated":false},{"title":"enquiry-reopened-event","summary":"Enquiry Reopened","prefix":{"name":"post","color":"post"},"badges":[],"link":"/enquiries/webhookenquiryreopenedevent","deprecated":false}]}]}]}]}},{"type":"group","label":"Quotes","link":"/xenia-connect/spec/quotes","routeSlug":"/xenia-connect/spec/quotes","items":[{"label":"Get a paginated list of quotes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/xenia-connect/spec/quotes/getquotes","routeSlug":"/xenia-connect/spec/quotes/getquotes","metadata":{"seo":{"title":"Get a paginated list of quotes","description":"Get a paginated list of quotes, optionally filtered by Situ enquiry id or the external id provided when calling the create enquiry endpoint."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getQuotes","name":"Get a paginated list of quotes","isWebhook":false,"pointer":"/paths/~1external-api~1v1~1quotes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a paginated list of quotes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a paginated list of quotes, optionally filtered by Situ enquiry id or the external id provided when calling the create enquiry endpoint."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-Api-Key"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_2","description":"Optional cursor used to pull the next or previous page for pagination.","example":"MTIzZTQ1NjctZTg5Yi0xMmQzLWE0NTYtNDI2NjE0MTc0MDAwfDIwMjQtMDctMDFUMTQ6MzA6MDBafE5leHQ="},{"name":"pageSize","in":"query","schemaId":"schema_3","description":"The maximum number of items to return.","example":10},{"name":"order","in":"query","schemaId":"schema_4","description":"Indicates whether to order the items in ascending or descending order."},{"name":"sort","in":"query","schemaId":"schema_5","description":"Used in conjunction with the order parameter and determines which field we're ordering by."},{"name":"xeniaEnquiryReference","in":"query","schemaId":"schema_2","description":"Optionally filter quotes by the xenia enquiry ID.","example":"R4E2F3A4"},{"name":"enquiryExternalId","in":"query","schemaId":"schema_6","description":"Optionally filter quotes by the client supplied external enquiry ID.","example":"e234abcef"}],"pointer":"/paths/~1external-api~1v1~1quotes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/external-api/v1/quotes","servers":[{"url":"/_mock/xenia-connect/spec","description":"Mock server","isMockServer":true},{"url":"https://api-xenia.staysitu.com","description":"Production"},{"url":"https://api-xenia-cisandbox.staysitu.com","description":"Sandbox"}],"parameters":{"path":[],"query":[{"name":"cursor","in":"query","example":"MTIzZTQ1NjctZTg5Yi0xMmQzLWE0NTYtNDI2NjE0MTc0MDAwfDIwMjQtMDctMDFUMTQ6MzA6MDBafE5leHQ=","schemaId":"schema_2"},{"name":"pageSize","in":"query","example":10,"schemaId":"schema_3"},{"name":"order","in":"query","example":"desc","schemaId":"components/schemas/paginationOrder"},{"name":"sort","in":"query","example":"createdAt","schemaId":"components/schemas/quoteListSortField"},{"name":"xeniaEnquiryReference","in":"query","example":"R4E2F3A4","schemaId":"schema_2"},{"name":"enquiryExternalId","in":"query","example":"e234abcef","schemaId":"components/schemas/enquiryExternalIdFilter"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","500"],"pointer":"/external-api/v1/quotes","href":"quotes/getquotes","openApiOperationId":"getQuotes","summary":"Get a paginated list of quotes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/xenia-connect/spec","description":"Mock server","isMockServer":true},{"url":"https://api-xenia.staysitu.com","description":"Production"},{"url":"https://api-xenia-cisandbox.staysitu.com","description":"Sandbox"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Paginated list of quotes.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/quotesResponse","exampleIds":["paths/~1external-api~1v1~1quotes/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/quotesResponse","exampleIds":["paths/~1external-api~1v1~1quotes/get/responses/200/content/application~1json/example"]},{"code":"401","description":"Failed to authenticate the request. This may be because the token is invalid or expired."},{"code":"403","description":"Failed to authorize the request. This may be because you not have the required permissions."},{"code":"404","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The quote was not found. This may be because the ID provided is invalid. The provided error status will be "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"RESOURCE_NOT_FOUND"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/problemDetails","exampleIds":["paths/~1external-api~1v1~1quotes/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"components/schemas/problemDetails","exampleIds":["paths/~1external-api~1v1~1quotes/get/responses/404/content/application~1problem+json/example"]},{"code":"500","description":"An error occurred on the server, you may be able to find more detail inside the error object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/problemDetails"}},"schemaId":"components/schemas/problemDetails"}],"pointer":"/paths/~1external-api~1v1~1quotes/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/quotesResponse","exampleIds":["paths/~1external-api~1v1~1quotes/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/quotesResponse","exampleIds":["paths/~1external-api~1v1~1quotes/get/responses/200/content/application~1json/example"]}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/problemDetails","exampleIds":["paths/~1external-api~1v1~1quotes/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/problemDetails","exampleIds":["paths/~1external-api~1v1~1quotes/get/responses/404/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"components/schemas/problemDetails","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/problemDetails"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/quotes/getquotes"}],"panels":[]}]},"httpPath":"/external-api/v1/quotes"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"Quote Created","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/xenia-connect/spec/quotes/webhookquotecreatedevent","routeSlug":"/xenia-connect/spec/quotes/webhookquotecreatedevent","metadata":{"seo":{"title":"Quote Created","description":"This event payload is sent to the eligible registered webhooks when a new quote is created."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhookQuoteCreatedEvent","name":"Quote Created","isWebhook":true,"pointer":"/paths/quote-created-event/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Quote Created","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This event payload is sent to the eligible registered webhooks when a new quote is created."},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature","in":"header","schemaId":"schema_0","description":"HMAC-SHA256 signature of the request body using the webhook secret key. Use this to verify the authenticity of the webhook payload.","required":true}],"pointer":"/paths/quote-created-event/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/quoteWebhookPayload","exampleIds":["paths/quote-created-event/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/quoteWebhookPayload","exampleIds":["paths/quote-created-event/post/requestBody/content/application~1json/example"],"pointer":"/paths/quote-created-event/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"quote-created-event","servers":[{"url":"/_mock/xenia-connect/spec","description":"Mock server","isMockServer":true},{"url":"https://api-xenia.staysitu.com","description":"Production"},{"url":"https://api-xenia-cisandbox.staysitu.com","description":"Sandbox"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature","in":"header","required":true,"example":"dGhpcyBpcyBhIHNhbXBsZSBzaWduYXR1cmU=","schemaId":"schema_0"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/quoteWebhookPayload","exampleIds":["paths/quote-created-event/post/requestBody/content/application~1json/example"]}},"responseCodes":["204","400","500","503"],"pointer":"quote-created-event","href":"quotes/webhookquotecreatedevent","openApiOperationId":"webhookQuoteCreatedEvent","summary":"Quote Created"},"isWebhook":true,"hideReplay":false,"schemaId":"components/schemas/quoteWebhookPayload","exampleIds":["paths/quote-created-event/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/quoteWebhookPayload","exampleIds":["paths/quote-created-event/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"The webhook was successfully received, Xenia will not try to process this again."},{"code":"400","description":"The webhook was not received successfully, Xenia will retry this webhook up to 5 times."},{"code":"500","description":"The webhook was not received successfully, Xenia will retry this webhook up to 5 times."},{"code":"503","description":"The webhook was not received successfully, Xenia will retry this webhook up to 5 times."}],"pointer":"/paths/quote-created-event/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/quotes/webhookquotecreatedevent"}],"panels":[]}]},"httpPath":"quote-created-event"},{"label":"Quote Invalidated","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/xenia-connect/spec/quotes/webhookquoteinvalidatedevent","routeSlug":"/xenia-connect/spec/quotes/webhookquoteinvalidatedevent","metadata":{"seo":{"title":"Quote Invalidated","description":"This event payload is sent to the eligible registered webhooks when a quote is invalidated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhookQuoteInvalidatedEvent","name":"Quote Invalidated","isWebhook":true,"pointer":"/paths/quote-invalidated-event/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Quote Invalidated","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This event payload is sent to the eligible registered webhooks when a quote is invalidated."},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature","in":"header","schemaId":"schema_0","description":"HMAC-SHA256 signature of the request body using the webhook secret key. Use this to verify the authenticity of the webhook payload.","required":true}],"pointer":"/paths/quote-invalidated-event/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/quoteWebhookPayload","exampleIds":["paths/quote-invalidated-event/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/quoteWebhookPayload","exampleIds":["paths/quote-invalidated-event/post/requestBody/content/application~1json/example"],"pointer":"/paths/quote-invalidated-event/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"quote-invalidated-event","servers":[{"url":"/_mock/xenia-connect/spec","description":"Mock server","isMockServer":true},{"url":"https://api-xenia.staysitu.com","description":"Production"},{"url":"https://api-xenia-cisandbox.staysitu.com","description":"Sandbox"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature","in":"header","required":true,"example":"dGhpcyBpcyBhIHNhbXBsZSBzaWduYXR1cmU=","schemaId":"schema_0"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/quoteWebhookPayload","exampleIds":["paths/quote-invalidated-event/post/requestBody/content/application~1json/example"]}},"responseCodes":["204","400","500","503"],"pointer":"quote-invalidated-event","href":"quotes/webhookquoteinvalidatedevent","openApiOperationId":"webhookQuoteInvalidatedEvent","summary":"Quote Invalidated"},"isWebhook":true,"hideReplay":false,"schemaId":"components/schemas/quoteWebhookPayload","exampleIds":["paths/quote-invalidated-event/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/quoteWebhookPayload","exampleIds":["paths/quote-invalidated-event/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"The webhook was successfully received, Xenia will not try to process this again."},{"code":"400","description":"The webhook was not received successfully, Xenia will retry this webhook up to 5 times."},{"code":"500","description":"The webhook was not received successfully, Xenia will retry this webhook up to 5 times."},{"code":"503","description":"The webhook was not received successfully, Xenia will retry this webhook up to 5 times."}],"pointer":"/paths/quote-invalidated-event/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/quotes/webhookquoteinvalidatedevent"}],"panels":[]}]},"httpPath":"quote-invalidated-event"}],"content":{"contentType":"group","meta":{"name":"quotes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Quotes","showPageActions":true},{"nodeType":"markdoc","content":"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."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/external-api/v1/quotes","summary":"Get a paginated list of quotes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/quotes/getquotes","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"quote-created-event","summary":"Quote Created","prefix":{"name":"post","color":"post"},"badges":[],"link":"/quotes/webhookquotecreatedevent","deprecated":false},{"title":"quote-invalidated-event","summary":"Quote Invalidated","prefix":{"name":"post","color":"post"},"badges":[],"link":"/quotes/webhookquoteinvalidatedevent","deprecated":false}]}]}]}]}},{"type":"group","label":"Sandbox Operations","link":"/xenia-connect/spec/sandbox","routeSlug":"/xenia-connect/spec/sandbox","items":[{"label":"Change Enquiry State","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/xenia-connect/spec/sandbox/changeenquirystate","routeSlug":"/xenia-connect/spec/sandbox/changeenquirystate","metadata":{"seo":{"title":"Change Enquiry State","description":"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"changeEnquiryState","name":"Change Enquiry State","isWebhook":false,"pointer":"/paths/~1external-api~1v1~1sandbox~1enquiries~1{id}~1change-state/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Change Enquiry State","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"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 "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"QUOTED"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" then it will trigger all eligible states before it, so in this example it would be "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"SHORTLISTING"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and then finally "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"QUOTED"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Some states will be exceptions such as "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"CLOSED"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" which can happen in any of the previous states. This is not available in production."},"children":[],"type":"text"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-Api-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Can be either the enquiries "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"xeniaReference"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"externalId"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"required":true,"example":"R4E2F3A4"}],"pointer":"/paths/~1external-api~1v1~1sandbox~1enquiries~1{id}~1change-state/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/sandboxEnquiryChangeStateRequest","exampleIds":["paths/~1external-api~1v1~1sandbox~1enquiries~1{id}~1change-state/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/sandboxEnquiryChangeStateRequest","exampleIds":["paths/~1external-api~1v1~1sandbox~1enquiries~1{id}~1change-state/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1external-api~1v1~1sandbox~1enquiries~1{id}~1change-state/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/external-api/v1/sandbox/enquiries/{id}/change-state","servers":[{"url":"/_mock/xenia-connect/spec","description":"Mock server","isMockServer":true},{"url":"https://api-xenia.staysitu.com","description":"Production"},{"url":"https://api-xenia-cisandbox.staysitu.com","description":"Sandbox"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"R4E2F3A4","schemaId":"schema_1"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/sandboxEnquiryChangeStateRequest","exampleIds":["paths/~1external-api~1v1~1sandbox~1enquiries~1{id}~1change-state/post/requestBody/content/application~1json/example"]}},"responseCodes":["204","401","403","404"],"pointer":"/external-api/v1/sandbox/enquiries/{id}/change-state","href":"sandbox/changeenquirystate","openApiOperationId":"changeEnquiryState","summary":"Change Enquiry State"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/xenia-connect/spec","description":"Mock server","isMockServer":true},{"url":"https://api-xenia.staysitu.com","description":"Production"},{"url":"https://api-xenia-cisandbox.staysitu.com","description":"Sandbox"}],"schemaId":"components/schemas/sandboxEnquiryChangeStateRequest","exampleIds":["paths/~1external-api~1v1~1sandbox~1enquiries~1{id}~1change-state/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/sandboxEnquiryChangeStateRequest","exampleIds":["paths/~1external-api~1v1~1sandbox~1enquiries~1{id}~1change-state/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successfully triggered"},{"code":"401","description":"Failed to authenticate the request. This may be because the token is invalid or expired."},{"code":"403","description":"Failed to authorize the request. This may be because you not have the required permissions."},{"code":"404","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The enquiry was not found. This may be because the enquiry has been deleted or the ID provided is invalid. The provided error status will be "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"RESOURCE_NOT_FOUND"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/problemDetails","exampleIds":["paths/~1external-api~1v1~1sandbox~1enquiries~1{id}~1change-state/post/responses/404/content/application~1problem+json/example"]}},"schemaId":"components/schemas/problemDetails","exampleIds":["paths/~1external-api~1v1~1sandbox~1enquiries~1{id}~1change-state/post/responses/404/content/application~1problem+json/example"]}],"pointer":"/paths/~1external-api~1v1~1sandbox~1enquiries~1{id}~1change-state/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/problemDetails","exampleIds":["paths/~1external-api~1v1~1sandbox~1enquiries~1{id}~1change-state/post/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/problemDetails","exampleIds":["paths/~1external-api~1v1~1sandbox~1enquiries~1{id}~1change-state/post/responses/404/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sandbox/changeenquirystate"}],"panels":[]}]},"httpPath":"/external-api/v1/sandbox/enquiries/{id}/change-state"},{"label":"Trigger Enquiry Webhook Event","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/xenia-connect/spec/sandbox/triggerenquirywebhookevent","routeSlug":"/xenia-connect/spec/sandbox/triggerenquirywebhookevent","metadata":{"seo":{"title":"Trigger Enquiry Webhook Event","description":"Trigger a webhook event for an enquiry in the sandbox environment. This is not available in production."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"triggerEnquiryWebhookEvent","name":"Trigger Enquiry Webhook Event","isWebhook":false,"pointer":"/paths/~1external-api~1v1~1sandbox~1enquiries~1{id}~1trigger-webhook-event/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Trigger Enquiry Webhook Event","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Trigger a webhook event for an enquiry in the sandbox environment. This is not available in production."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-Api-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Can be either the enquiries "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"xeniaReference"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"externalId"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"required":true,"example":"R4E2F3A4"}],"pointer":"/paths/~1external-api~1v1~1sandbox~1enquiries~1{id}~1trigger-webhook-event/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/sandboxEnquiryTriggerWebhookEventRequest","exampleIds":["paths/~1external-api~1v1~1sandbox~1enquiries~1{id}~1trigger-webhook-event/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/sandboxEnquiryTriggerWebhookEventRequest","exampleIds":["paths/~1external-api~1v1~1sandbox~1enquiries~1{id}~1trigger-webhook-event/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1external-api~1v1~1sandbox~1enquiries~1{id}~1trigger-webhook-event/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/external-api/v1/sandbox/enquiries/{id}/trigger-webhook-event","servers":[{"url":"/_mock/xenia-connect/spec","description":"Mock server","isMockServer":true},{"url":"https://api-xenia.staysitu.com","description":"Production"},{"url":"https://api-xenia-cisandbox.staysitu.com","description":"Sandbox"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"R4E2F3A4","schemaId":"schema_1"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/sandboxEnquiryTriggerWebhookEventRequest","exampleIds":["paths/~1external-api~1v1~1sandbox~1enquiries~1{id}~1trigger-webhook-event/post/requestBody/content/application~1json/example"]}},"responseCodes":["204","401","403","404"],"pointer":"/external-api/v1/sandbox/enquiries/{id}/trigger-webhook-event","href":"sandbox/triggerenquirywebhookevent","openApiOperationId":"triggerEnquiryWebhookEvent","summary":"Trigger Enquiry Webhook Event"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/xenia-connect/spec","description":"Mock server","isMockServer":true},{"url":"https://api-xenia.staysitu.com","description":"Production"},{"url":"https://api-xenia-cisandbox.staysitu.com","description":"Sandbox"}],"schemaId":"components/schemas/sandboxEnquiryTriggerWebhookEventRequest","exampleIds":["paths/~1external-api~1v1~1sandbox~1enquiries~1{id}~1trigger-webhook-event/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/sandboxEnquiryTriggerWebhookEventRequest","exampleIds":["paths/~1external-api~1v1~1sandbox~1enquiries~1{id}~1trigger-webhook-event/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successfully changed state"},{"code":"401","description":"Failed to authenticate the request. This may be because the token is invalid or expired."},{"code":"403","description":"Failed to authorize the request. This may be because you not have the required permissions."},{"code":"404","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The enquiry was not found. This may be because the enquiry has been deleted or the ID provided is invalid. The provided error status will be "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"RESOURCE_NOT_FOUND"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/problemDetails","exampleIds":["paths/~1external-api~1v1~1sandbox~1enquiries~1{id}~1trigger-webhook-event/post/responses/404/content/application~1problem+json/example"]}},"schemaId":"components/schemas/problemDetails","exampleIds":["paths/~1external-api~1v1~1sandbox~1enquiries~1{id}~1trigger-webhook-event/post/responses/404/content/application~1problem+json/example"]}],"pointer":"/paths/~1external-api~1v1~1sandbox~1enquiries~1{id}~1trigger-webhook-event/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/problemDetails","exampleIds":["paths/~1external-api~1v1~1sandbox~1enquiries~1{id}~1trigger-webhook-event/post/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/problemDetails","exampleIds":["paths/~1external-api~1v1~1sandbox~1enquiries~1{id}~1trigger-webhook-event/post/responses/404/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sandbox/triggerenquirywebhookevent"}],"panels":[]}]},"httpPath":"/external-api/v1/sandbox/enquiries/{id}/trigger-webhook-event"}],"content":{"contentType":"group","meta":{"name":"sandbox"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sandbox Operations","showPageActions":true},{"nodeType":"markdoc","content":"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."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/external-api/v1/sandbox/enquiries/{id}/change-state","summary":"Change Enquiry State","prefix":{"name":"post","color":"post"},"badges":[],"link":"/sandbox/changeenquirystate","deprecated":false},{"title":"/external-api/v1/sandbox/enquiries/{id}/trigger-webhook-event","summary":"Trigger Enquiry Webhook Event","prefix":{"name":"post","color":"post"},"badges":[],"link":"/sandbox/triggerenquirywebhookevent","deprecated":false}]}]}]}]}},{"type":"group","label":"Webhook Operations","link":"/xenia-connect/spec/webhooks","routeSlug":"/xenia-connect/spec/webhooks","items":[{"label":"Get all webhooks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/xenia-connect/spec/webhooks/listwebhooks","routeSlug":"/xenia-connect/spec/webhooks/listwebhooks","metadata":{"seo":{"title":"Get all webhooks","description":"Get all webhooks for the current environment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listWebhooks","name":"Get all webhooks","isWebhook":false,"pointer":"/paths/~1external-api~1v1~1webhooks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all webhooks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get all webhooks for the current environment."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-Api-Key"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/external-api/v1/webhooks","servers":[{"url":"/_mock/xenia-connect/spec","description":"Mock server","isMockServer":true},{"url":"https://api-xenia.staysitu.com","description":"Production"},{"url":"https://api-xenia-cisandbox.staysitu.com","description":"Sandbox"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","500"],"pointer":"/external-api/v1/webhooks","href":"webhooks/listwebhooks","openApiOperationId":"listWebhooks","summary":"Get all webhooks"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/xenia-connect/spec","description":"Mock server","isMockServer":true},{"url":"https://api-xenia.staysitu.com","description":"Production"},{"url":"https://api-xenia-cisandbox.staysitu.com","description":"Sandbox"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of webhooks.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/webhooksResponse","exampleIds":["paths/~1external-api~1v1~1webhooks/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/webhooksResponse","exampleIds":["paths/~1external-api~1v1~1webhooks/get/responses/200/content/application~1json/example"]},{"code":"400","description":"The request was malformed, e.g. invalid query parameters.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/problemDetails","exampleIds":["paths/~1external-api~1v1~1webhooks/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"components/schemas/problemDetails","exampleIds":["paths/~1external-api~1v1~1webhooks/get/responses/400/content/application~1problem+json/example"]},{"code":"401","description":"Failed to authenticate the request. This may be because the token is invalid or expired."},{"code":"403","description":"Failed to authorize the request. This may be because you not have the required permissions."},{"code":"500","description":"An error occurred on the server, you may be able to find more detail inside the error object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/problemDetails","exampleIds":["paths/~1external-api~1v1~1webhooks/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"components/schemas/problemDetails","exampleIds":["paths/~1external-api~1v1~1webhooks/get/responses/500/content/application~1problem+json/example"]}],"pointer":"/paths/~1external-api~1v1~1webhooks/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/webhooksResponse","exampleIds":["paths/~1external-api~1v1~1webhooks/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/webhooksResponse","exampleIds":["paths/~1external-api~1v1~1webhooks/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/problemDetails","exampleIds":["paths/~1external-api~1v1~1webhooks/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/problemDetails","exampleIds":["paths/~1external-api~1v1~1webhooks/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401"},{"code":"403"},{"code":"500","schemaId":"components/schemas/problemDetails","exampleIds":["paths/~1external-api~1v1~1webhooks/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/problemDetails","exampleIds":["paths/~1external-api~1v1~1webhooks/get/responses/500/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/listwebhooks"}],"panels":[]}]},"httpPath":"/external-api/v1/webhooks"},{"label":"Create a new webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/xenia-connect/spec/webhooks/createwebhook","routeSlug":"/xenia-connect/spec/webhooks/createwebhook","metadata":{"seo":{"title":"Create a new webhook","description":"Create a new webhook for Xenia to send events to."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createWebhook","name":"Create a new webhook","isWebhook":false,"pointer":"/paths/~1external-api~1v1~1webhooks/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new webhook for Xenia to send events to."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-Api-Key"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/createOrUpdateWebhookRequest","exampleIds":["paths/~1external-api~1v1~1webhooks/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/createOrUpdateWebhookRequest","exampleIds":["paths/~1external-api~1v1~1webhooks/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1external-api~1v1~1webhooks/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/external-api/v1/webhooks","servers":[{"url":"/_mock/xenia-connect/spec","description":"Mock server","isMockServer":true},{"url":"https://api-xenia.staysitu.com","description":"Production"},{"url":"https://api-xenia-cisandbox.staysitu.com","description":"Sandbox"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/createOrUpdateWebhookRequest","exampleIds":["paths/~1external-api~1v1~1webhooks/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","400","401","403","500"],"pointer":"/external-api/v1/webhooks","href":"webhooks/createwebhook","openApiOperationId":"createWebhook","summary":"Create a new webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/xenia-connect/spec","description":"Mock server","isMockServer":true},{"url":"https://api-xenia.staysitu.com","description":"Production"},{"url":"https://api-xenia-cisandbox.staysitu.com","description":"Sandbox"}],"schemaId":"components/schemas/createOrUpdateWebhookRequest","exampleIds":["paths/~1external-api~1v1~1webhooks/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/createOrUpdateWebhookRequest","exampleIds":["paths/~1external-api~1v1~1webhooks/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The created webhook object.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/webhookResponse","exampleIds":["paths/~1external-api~1v1~1webhooks/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/webhookResponse","exampleIds":["paths/~1external-api~1v1~1webhooks/post/responses/201/content/application~1json/example"]},{"code":"400","description":"Validation errors have occurred, e.g. missing required fields or invalid data types.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/validationErrorsResponse","exampleIds":["paths/~1external-api~1v1~1webhooks/post/responses/400/content/application~1problem+json/example"]}},"schemaId":"components/schemas/validationErrorsResponse","exampleIds":["paths/~1external-api~1v1~1webhooks/post/responses/400/content/application~1problem+json/example"]},{"code":"401","description":"Failed to authenticate the request. This may be because the token is invalid or expired."},{"code":"403","description":"Failed to authorize the request. This may be because you not have the required permissions."},{"code":"500","description":"An error occurred on the server, you may be able to find more detail inside the error object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/problemDetails","exampleIds":["paths/~1external-api~1v1~1webhooks/post/responses/500/content/application~1problem+json/example"]}},"schemaId":"components/schemas/problemDetails","exampleIds":["paths/~1external-api~1v1~1webhooks/post/responses/500/content/application~1problem+json/example"]}],"pointer":"/paths/~1external-api~1v1~1webhooks/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/webhookResponse","exampleIds":["paths/~1external-api~1v1~1webhooks/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/webhookResponse","exampleIds":["paths/~1external-api~1v1~1webhooks/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/validationErrorsResponse","exampleIds":["paths/~1external-api~1v1~1webhooks/post/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/validationErrorsResponse","exampleIds":["paths/~1external-api~1v1~1webhooks/post/responses/400/content/application~1problem+json/example"]}}},{"code":"401"},{"code":"403"},{"code":"500","schemaId":"components/schemas/problemDetails","exampleIds":["paths/~1external-api~1v1~1webhooks/post/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/problemDetails","exampleIds":["paths/~1external-api~1v1~1webhooks/post/responses/500/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/createwebhook"}],"panels":[]}]},"httpPath":"/external-api/v1/webhooks"},{"label":"Delete a webhook","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/xenia-connect/spec/webhooks/deletewebhook","routeSlug":"/xenia-connect/spec/webhooks/deletewebhook","metadata":{"seo":{"title":"Delete a webhook","description":"Delete a webhook by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteWebhook","name":"Delete a webhook","isWebhook":false,"pointer":"/paths/~1external-api~1v1~1webhooks~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a webhook by ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-Api-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_7","description":"The ID of the webhook.","required":true,"example":"123e4567-e89b-12d3-a456-426614174000"}],"pointer":"/paths/~1external-api~1v1~1webhooks~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/external-api/v1/webhooks/{id}","servers":[{"url":"/_mock/xenia-connect/spec","description":"Mock server","isMockServer":true},{"url":"https://api-xenia.staysitu.com","description":"Production"},{"url":"https://api-xenia-cisandbox.staysitu.com","description":"Sandbox"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"123e4567-e89b-12d3-a456-426614174000","schemaId":"schema_7"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":[]}],"responseCodes":["204","401","403","404","500"],"pointer":"/external-api/v1/webhooks/{id}","href":"webhooks/deletewebhook","openApiOperationId":"deleteWebhook","summary":"Delete a webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/xenia-connect/spec","description":"Mock server","isMockServer":true},{"url":"https://api-xenia.staysitu.com","description":"Production"},{"url":"https://api-xenia-cisandbox.staysitu.com","description":"Sandbox"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No content, the webhook was successfully deleted."},{"code":"401","description":"Failed to authenticate the request. This may be because the token is invalid or expired."},{"code":"403","description":"Failed to authorize the request. This may be because you not have the required permissions."},{"code":"404","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The webhook was not found. This may be because the webhook has been deleted or the ID provided is invalid. The provided error status will be "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"RESOURCE_NOT_FOUND"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/problemDetails","exampleIds":["paths/~1external-api~1v1~1webhooks~1{id}/delete/responses/404/content/application~1problem+json/example"]}},"schemaId":"components/schemas/problemDetails","exampleIds":["paths/~1external-api~1v1~1webhooks~1{id}/delete/responses/404/content/application~1problem+json/example"]},{"code":"500","description":"An error occurred on the server, you may be able to find more detail inside the error object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/problemDetails","exampleIds":["paths/~1external-api~1v1~1webhooks~1{id}/delete/responses/500/content/application~1problem+json/example"]}},"schemaId":"components/schemas/problemDetails","exampleIds":["paths/~1external-api~1v1~1webhooks~1{id}/delete/responses/500/content/application~1problem+json/example"]}],"pointer":"/paths/~1external-api~1v1~1webhooks~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/problemDetails","exampleIds":["paths/~1external-api~1v1~1webhooks~1{id}/delete/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/problemDetails","exampleIds":["paths/~1external-api~1v1~1webhooks~1{id}/delete/responses/404/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"components/schemas/problemDetails","exampleIds":["paths/~1external-api~1v1~1webhooks~1{id}/delete/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/problemDetails","exampleIds":["paths/~1external-api~1v1~1webhooks~1{id}/delete/responses/500/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/deletewebhook"}],"panels":[]}]},"httpPath":"/external-api/v1/webhooks/{id}"},{"label":"Get a webhook","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/xenia-connect/spec/webhooks/getwebhook","routeSlug":"/xenia-connect/spec/webhooks/getwebhook","metadata":{"seo":{"title":"Get a webhook","description":"Get a webhook by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWebhook","name":"Get a webhook","isWebhook":false,"pointer":"/paths/~1external-api~1v1~1webhooks~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a webhook by ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-Api-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_7","description":"The ID of the webhook.","required":true,"example":"123e4567-e89b-12d3-a456-426614174000"}],"pointer":"/paths/~1external-api~1v1~1webhooks~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/external-api/v1/webhooks/{id}","servers":[{"url":"/_mock/xenia-connect/spec","description":"Mock server","isMockServer":true},{"url":"https://api-xenia.staysitu.com","description":"Production"},{"url":"https://api-xenia-cisandbox.staysitu.com","description":"Sandbox"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"123e4567-e89b-12d3-a456-426614174000","schemaId":"schema_7"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","500"],"pointer":"/external-api/v1/webhooks/{id}","href":"webhooks/getwebhook","openApiOperationId":"getWebhook","summary":"Get a webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/xenia-connect/spec","description":"Mock server","isMockServer":true},{"url":"https://api-xenia.staysitu.com","description":"Production"},{"url":"https://api-xenia-cisandbox.staysitu.com","description":"Sandbox"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The webhook object.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/webhookResponse","exampleIds":["paths/~1external-api~1v1~1webhooks~1{id}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/webhookResponse","exampleIds":["paths/~1external-api~1v1~1webhooks~1{id}/get/responses/200/content/application~1json/example"]},{"code":"401","description":"Failed to authenticate the request. This may be because the token is invalid or expired."},{"code":"403","description":"Failed to authorize the request. This may be because you not have the required permissions."},{"code":"404","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The webhook was not found. This may be because the webhook has been deleted or the ID provided is invalid. The provided error status will be "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"RESOURCE_NOT_FOUND"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/problemDetails","exampleIds":["paths/~1external-api~1v1~1webhooks~1{id}/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"components/schemas/problemDetails","exampleIds":["paths/~1external-api~1v1~1webhooks~1{id}/get/responses/404/content/application~1problem+json/example"]},{"code":"500","description":"An error occurred on the server, you may be able to find more detail inside the error object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/problemDetails","exampleIds":["paths/~1external-api~1v1~1webhooks~1{id}/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"components/schemas/problemDetails","exampleIds":["paths/~1external-api~1v1~1webhooks~1{id}/get/responses/500/content/application~1problem+json/example"]}],"pointer":"/paths/~1external-api~1v1~1webhooks~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/webhookResponse","exampleIds":["paths/~1external-api~1v1~1webhooks~1{id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/webhookResponse","exampleIds":["paths/~1external-api~1v1~1webhooks~1{id}/get/responses/200/content/application~1json/example"]}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/problemDetails","exampleIds":["paths/~1external-api~1v1~1webhooks~1{id}/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/problemDetails","exampleIds":["paths/~1external-api~1v1~1webhooks~1{id}/get/responses/404/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"components/schemas/problemDetails","exampleIds":["paths/~1external-api~1v1~1webhooks~1{id}/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/problemDetails","exampleIds":["paths/~1external-api~1v1~1webhooks~1{id}/get/responses/500/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/getwebhook"}],"panels":[]}]},"httpPath":"/external-api/v1/webhooks/{id}"},{"label":"Update a webhook","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/xenia-connect/spec/webhooks/updatewebhook","routeSlug":"/xenia-connect/spec/webhooks/updatewebhook","metadata":{"seo":{"title":"Update a webhook","description":"Update an existing webhook."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateWebhook","name":"Update a webhook","isWebhook":false,"pointer":"/paths/~1external-api~1v1~1webhooks~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update an existing webhook."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-Api-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_7","description":"The ID of the webhook.","required":true,"example":"123e4567-e89b-12d3-a456-426614174000"}],"pointer":"/paths/~1external-api~1v1~1webhooks~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/createOrUpdateWebhookRequest","exampleIds":["paths/~1external-api~1v1~1webhooks~1{id}/put/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/createOrUpdateWebhookRequest","exampleIds":["paths/~1external-api~1v1~1webhooks~1{id}/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1external-api~1v1~1webhooks~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/external-api/v1/webhooks/{id}","servers":[{"url":"/_mock/xenia-connect/spec","description":"Mock server","isMockServer":true},{"url":"https://api-xenia.staysitu.com","description":"Production"},{"url":"https://api-xenia-cisandbox.staysitu.com","description":"Sandbox"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"123e4567-e89b-12d3-a456-426614174000","schemaId":"schema_7"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/createOrUpdateWebhookRequest","exampleIds":["paths/~1external-api~1v1~1webhooks~1{id}/put/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","403","404","500"],"pointer":"/external-api/v1/webhooks/{id}","href":"webhooks/updatewebhook","openApiOperationId":"updateWebhook","summary":"Update a webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/xenia-connect/spec","description":"Mock server","isMockServer":true},{"url":"https://api-xenia.staysitu.com","description":"Production"},{"url":"https://api-xenia-cisandbox.staysitu.com","description":"Sandbox"}],"schemaId":"components/schemas/createOrUpdateWebhookRequest","exampleIds":["paths/~1external-api~1v1~1webhooks~1{id}/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/createOrUpdateWebhookRequest","exampleIds":["paths/~1external-api~1v1~1webhooks~1{id}/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The updated webhook object.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/webhookResponse","exampleIds":["paths/~1external-api~1v1~1webhooks~1{id}/put/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/webhookResponse","exampleIds":["paths/~1external-api~1v1~1webhooks~1{id}/put/responses/200/content/application~1json/example"]},{"code":"400","description":"Validation errors have occurred, e.g. missing required fields or invalid data types.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/validationErrorsResponse","exampleIds":["paths/~1external-api~1v1~1webhooks~1{id}/put/responses/400/content/application~1problem+json/example"]}},"schemaId":"components/schemas/validationErrorsResponse","exampleIds":["paths/~1external-api~1v1~1webhooks~1{id}/put/responses/400/content/application~1problem+json/example"]},{"code":"401","description":"Failed to authenticate the request. This may be because the token is invalid or expired."},{"code":"403","description":"Failed to authorize the request. This may be because you not have the required permissions."},{"code":"404","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The webhook was not found. This may be because the webhook has been deleted or the ID provided is invalid. The provided error status will be "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"RESOURCE_NOT_FOUND"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/problemDetails","exampleIds":["paths/~1external-api~1v1~1webhooks~1{id}/put/responses/404/content/application~1problem+json/example"]}},"schemaId":"components/schemas/problemDetails","exampleIds":["paths/~1external-api~1v1~1webhooks~1{id}/put/responses/404/content/application~1problem+json/example"]},{"code":"500","description":"An error occurred on the server, you may be able to find more detail inside the error object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/problemDetails","exampleIds":["paths/~1external-api~1v1~1webhooks~1{id}/put/responses/500/content/application~1problem+json/example"]}},"schemaId":"components/schemas/problemDetails","exampleIds":["paths/~1external-api~1v1~1webhooks~1{id}/put/responses/500/content/application~1problem+json/example"]}],"pointer":"/paths/~1external-api~1v1~1webhooks~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/webhookResponse","exampleIds":["paths/~1external-api~1v1~1webhooks~1{id}/put/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/webhookResponse","exampleIds":["paths/~1external-api~1v1~1webhooks~1{id}/put/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/validationErrorsResponse","exampleIds":["paths/~1external-api~1v1~1webhooks~1{id}/put/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/validationErrorsResponse","exampleIds":["paths/~1external-api~1v1~1webhooks~1{id}/put/responses/400/content/application~1problem+json/example"]}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/problemDetails","exampleIds":["paths/~1external-api~1v1~1webhooks~1{id}/put/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/problemDetails","exampleIds":["paths/~1external-api~1v1~1webhooks~1{id}/put/responses/404/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"components/schemas/problemDetails","exampleIds":["paths/~1external-api~1v1~1webhooks~1{id}/put/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/problemDetails","exampleIds":["paths/~1external-api~1v1~1webhooks~1{id}/put/responses/500/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/updatewebhook"}],"panels":[]}]},"httpPath":"/external-api/v1/webhooks/{id}"},{"label":"Get webhook signature verification public key","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/xenia-connect/spec/webhooks/getwebhookpublickey","routeSlug":"/xenia-connect/spec/webhooks/getwebhookpublickey","metadata":{"seo":{"title":"Get webhook signature verification public key","description":"Get the public key used to verify webhook signatures. Use this key to verify that webhook payloads are authentically from Situ by validating the X-Signature header against the webhook body using HMAC-SHA256."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWebhookPublicKey","name":"Get webhook signature verification public key","isWebhook":false,"pointer":"/paths/~1external-api~1v1~1webhook-verification-key/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get webhook signature verification public key","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get the public key used to verify webhook signatures. Use this key to verify that webhook payloads are authentically from Situ by validating the X-Signature header against the webhook body using HMAC-SHA256."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-Api-Key"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/external-api/v1/webhook-verification-key","servers":[{"url":"/_mock/xenia-connect/spec","description":"Mock server","isMockServer":true},{"url":"https://api-xenia.staysitu.com","description":"Production"},{"url":"https://api-xenia-cisandbox.staysitu.com","description":"Sandbox"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","500"],"pointer":"/external-api/v1/webhook-verification-key","href":"webhooks/getwebhookpublickey","openApiOperationId":"getWebhookPublicKey","summary":"Get webhook signature verification public key"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/xenia-connect/spec","description":"Mock server","isMockServer":true},{"url":"https://api-xenia.staysitu.com","description":"Production"},{"url":"https://api-xenia-cisandbox.staysitu.com","description":"Sandbox"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The public key for webhook signature verification.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/webhookPublicKeyResponse","exampleIds":["paths/~1external-api~1v1~1webhook-verification-key/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/webhookPublicKeyResponse","exampleIds":["paths/~1external-api~1v1~1webhook-verification-key/get/responses/200/content/application~1json/example"]},{"code":"401","description":"Failed to authenticate the request. This may be because the token is invalid or expired."},{"code":"403","description":"Failed to authorize the request. This may be because you not have the required permissions."},{"code":"500","description":"An error occurred on the server, you may be able to find more detail inside the error object.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/problemDetails","exampleIds":["paths/~1external-api~1v1~1webhook-verification-key/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"components/schemas/problemDetails","exampleIds":["paths/~1external-api~1v1~1webhook-verification-key/get/responses/500/content/application~1problem+json/example"]}],"pointer":"/paths/~1external-api~1v1~1webhook-verification-key/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/webhookPublicKeyResponse","exampleIds":["paths/~1external-api~1v1~1webhook-verification-key/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/webhookPublicKeyResponse","exampleIds":["paths/~1external-api~1v1~1webhook-verification-key/get/responses/200/content/application~1json/example"]}}},{"code":"401"},{"code":"403"},{"code":"500","schemaId":"components/schemas/problemDetails","exampleIds":["paths/~1external-api~1v1~1webhook-verification-key/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/problemDetails","exampleIds":["paths/~1external-api~1v1~1webhook-verification-key/get/responses/500/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/getwebhookpublickey"}],"panels":[]}]},"httpPath":"/external-api/v1/webhook-verification-key"}],"content":{"contentType":"group","meta":{"name":"webhooks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Webhook Operations","showPageActions":true},{"nodeType":"markdoc","content":"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."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/external-api/v1/webhooks","summary":"Get all webhooks","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhooks/listwebhooks","deprecated":false},{"title":"/external-api/v1/webhooks","summary":"Create a new webhook","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/createwebhook","deprecated":false},{"title":"/external-api/v1/webhooks/{id}","summary":"Delete a webhook","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/webhooks/deletewebhook","deprecated":false},{"title":"/external-api/v1/webhooks/{id}","summary":"Get a webhook","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhooks/getwebhook","deprecated":false},{"title":"/external-api/v1/webhooks/{id}","summary":"Update a webhook","prefix":{"name":"put","color":"put"},"badges":[],"link":"/webhooks/updatewebhook","deprecated":false},{"title":"/external-api/v1/webhook-verification-key","summary":"Get webhook signature verification public key","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhooks/getwebhookpublickey","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/bookingReferenceId":{"id":"components/schemas/bookingReferenceId","kind":"json-schema","title":"bookingReferenceId","data":{"type":"string","description":"Xenia's reference for the booking.","example":"R4E2F3A4"}},"components/schemas/bookingWebhookPayload":{"id":"components/schemas/bookingWebhookPayload","kind":"json-schema","title":"bookingWebhookPayload","data":{"type":"object","description":"The event payload sent to the specified webhook URL. You are expected to pull the full object from the relevant endpoint.","properties":{"eventType":{"$ref":"#/components/schemas/webhookEvent"},"eventId":{"type":"string","format":"uuid","description":"Unique ID of the event. This can be used as the idempotent key.","example":"123e4567-e89b-12d3-a456-426614174000"},"createdAt":{"type":"string","format":"date-time","description":"When the event was created within Xenia's system.","example":"2026-01-01T15:12:56Z"},"data":{"$ref":"#/components/schemas/bookingWebhookEventData"}}}},"components/schemas/bookingWebhookEventData":{"id":"components/schemas/bookingWebhookEventData","kind":"json-schema","title":"bookingWebhookEventData","data":{"type":"object","description":"The data object for a booking event.","properties":{"bookingReference":{"$ref":"#/components/schemas/bookingReferenceId"},"createdAt":{"$ref":"#/components/schemas/utcTimestamp"},"enquiry":{"$ref":"#/components/schemas/enquiryWebhookEventData"}},"required":["bookingReference","createdAt","enquiry"]}},"components/schemas/webhookEvent":{"id":"components/schemas/webhookEvent","kind":"json-schema","title":"webhookEvent","data":{"description":"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","BOOKING.PARTNER_CONFIRMATION_DETAILS_SENT","BOOKING.CHECK_IN_DETAILS_SENT","BOOKING.CANCELLED"],"example":"ENQUIRY.CREATED","type":"string"}},"components/schemas/utcTimestamp":{"id":"components/schemas/utcTimestamp","kind":"json-schema","title":"utcTimestamp","data":{"description":"ISO-8601 UTC timestamp. The example is the expected format.","example":"2026-01-01T15:12:56Z","format":"date-time","type":"string"}},"components/schemas/enquiryExternalId":{"id":"components/schemas/enquiryExternalId","kind":"json-schema","title":"enquiryExternalId","data":{"description":"The external ID of the enquiry, this is a unique value that can be used to retrieve your enquiry via other endpoints where specified.","example":"e234abcef","maxLength":255,"minLength":3,"type":"string"}},"components/schemas/enquiryClientReferenceId":{"id":"components/schemas/enquiryClientReferenceId","kind":"json-schema","title":"enquiryClientReferenceId","data":{"description":"The clients reference for the enquiry. This may be the same as the external ID depending on your system.","example":"example-ref-567abc","maxLength":255,"minLength":3,"type":"string"}},"components/schemas/enquiryXeniaReferenceId":{"id":"components/schemas/enquiryXeniaReferenceId","kind":"json-schema","title":"enquiryXeniaReferenceId","data":{"description":"Xenia's reference for the enquiry.","example":"R4E2F3A4","type":"string"}},"components/schemas/enquiryWebhookEventData":{"id":"components/schemas/enquiryWebhookEventData","kind":"json-schema","title":"enquiryWebhookEventData","data":{"type":"object","description":"The data object for an enquiry event.","properties":{"externalId":{"$ref":"#/components/schemas/enquiryExternalId"},"clientReference":{"$ref":"#/components/schemas/enquiryClientReferenceId"},"xeniaReference":{"$ref":"#/components/schemas/enquiryXeniaReferenceId"},"createdAt":{"$ref":"#/components/schemas/utcTimestamp"}},"required":["externalId","clientReference","xeniaReference","createdAt"]}},"components/schemas/enquiryStateClosureReason":{"id":"components/schemas/enquiryStateClosureReason","kind":"json-schema","title":"enquiryStateClosureReason","data":{"description":"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","nullable":true,"type":"string"}},"components/schemas/problemDetails":{"id":"components/schemas/problemDetails","kind":"json-schema","title":"problemDetails","data":{"additionalProperties":true,"description":"A machine-readable format for specifying errors in HTTP APIs (RFC 7807).","properties":{"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request could not be understood due to malformed syntax.","type":"string"},"instance":{"description":"A URI reference or identifier that describes the specific occurrence of the problem.","example":"/api/v1/enquiries/abc","type":"string"},"status":{"description":"The HTTP status code.","example":400,"format":"int32","type":"integer"},"title":{"description":"A short, human-readable summary of the problem type.","example":"Bad Request","type":"string"},"type":{"$ref":"#/components/schemas/problemDetailsType"}},"required":["type","title","status"],"type":"object"}},"components/schemas/problemDetailsType":{"id":"components/schemas/problemDetailsType","kind":"json-schema","title":"problemDetailsType","data":{"description":"The error code as a machine-readable key.","enum":["RESOURCE_NOT_FOUND","VALIDATION_ERROR","RESOURCE_ALREADY_EXISTS","DUPLICATE_CLIENT_REFERENCE","GEOCODE_FAILURE","MALFORMED_REQUEST","INTERNAL_SERVER_ERROR","MAX_RESOURCE_COUNT_REACHED","SANDBOX_SPECIFIC_ACTION_ERROR"],"example":"GEOCODE_FAILURE","type":"string"}},"components/schemas/clientBooker":{"id":"components/schemas/clientBooker","kind":"json-schema","title":"clientBooker","data":{"description":"Details of the Booker for the enquiry or booking.","minProperties":1,"properties":{"contactNumber":{"description":"Booker contact number","example":"+447911992499","format":"phoneNumber","maxLength":50,"nullable":true,"type":"string"},"email":{"description":"Booker email","example":"Jess.Walters@example.com","maxLength":200,"pattern":"^[^@;\\s]+@[^@.;\\s]+(?:\\.\\w+){1,2}$","type":"string"},"familyName":{"description":"Booker family name","example":"Walters","maxLength":50,"type":"string"},"givenName":{"description":"Booker given name","example":"Jess","maxLength":50,"type":"string"}},"required":["givenName","familyName","email","contactNumber"],"type":"object"}},"components/schemas/errorResponse":{"id":"components/schemas/errorResponse","kind":"json-schema","title":"errorResponse","data":{"additionalProperties":true,"description":"A machine-readable format for specifying errors in HTTP APIs (RFC 7807).","properties":{"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request could not be understood due to malformed syntax.","type":"string"},"instance":{"description":"A URI reference or identifier that describes the specific occurrence of the problem.","example":"/api/v1/enquiries/abc","type":"string"},"status":{"description":"The HTTP status code.","example":400,"format":"int32","type":"integer"},"title":{"description":"A short, human-readable summary of the problem type.","example":"Bad Request","type":"string"},"type":{"$ref":"#/components/schemas/problemDetailsType"}},"required":["type","title","status"],"type":"object"}},"components/schemas/resourceNotFoundResponse":{"id":"components/schemas/resourceNotFoundResponse","kind":"json-schema","title":"resourceNotFoundResponse","data":{"additionalProperties":true,"description":"A machine-readable format for specifying errors in HTTP APIs (RFC 7807).","properties":{"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request could not be understood due to malformed syntax.","type":"string"},"instance":{"description":"A URI reference or identifier that describes the specific occurrence of the problem.","example":"/api/v1/enquiries/abc","type":"string"},"status":{"description":"The HTTP status code.","example":400,"format":"int32","type":"integer"},"title":{"description":"A short, human-readable summary of the problem type.","example":"Bad Request","type":"string"},"type":{"$ref":"#/components/schemas/problemDetailsType"}},"required":["type","title","status"],"type":"object"}},"components/schemas/serverErrorResponse":{"id":"components/schemas/serverErrorResponse","kind":"json-schema","title":"serverErrorResponse","data":{"additionalProperties":true,"description":"A machine-readable format for specifying errors in HTTP APIs (RFC 7807).","properties":{"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request could not be understood due to malformed syntax.","type":"string"},"instance":{"description":"A URI reference or identifier that describes the specific occurrence of the problem.","example":"/api/v1/enquiries/abc","type":"string"},"status":{"description":"The HTTP status code.","example":400,"format":"int32","type":"integer"},"title":{"description":"A short, human-readable summary of the problem type.","example":"Bad Request","type":"string"},"type":{"$ref":"#/components/schemas/problemDetailsType"}},"required":["type","title","status"],"type":"object"}},"components/schemas/badRequestResponse":{"id":"components/schemas/badRequestResponse","kind":"json-schema","title":"badRequestResponse","data":{"additionalProperties":true,"description":"A machine-readable format for specifying errors in HTTP APIs (RFC 7807).","properties":{"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request could not be understood due to malformed syntax.","type":"string"},"instance":{"description":"A URI reference or identifier that describes the specific occurrence of the problem.","example":"/api/v1/enquiries/abc","type":"string"},"status":{"description":"The HTTP status code.","example":400,"format":"int32","type":"integer"},"title":{"description":"A short, human-readable summary of the problem type.","example":"Bad Request","type":"string"},"type":{"$ref":"#/components/schemas/problemDetailsType"}},"required":["type","title","status"],"type":"object"}},"components/schemas/validationErrors":{"id":"components/schemas/validationErrors","kind":"json-schema","title":"validationErrors","data":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"A dictionary containing field-specific validation errors.","example":{"clientReference":["Client reference must be at least 3 characters."],"id":["The ID field is required."]},"type":"object"}},"components/schemas/validationErrorsResponse":{"id":"components/schemas/validationErrorsResponse","kind":"json-schema","title":"validationErrorsResponse","data":{"additionalProperties":true,"description":"A validation error response that extends ProblemDetails with field-level errors.","properties":{"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"Validation failed for one or more fields.","type":"string"},"errors":{"$ref":"#/components/schemas/validationErrors"},"instance":{"description":"A URI reference that identifies the specific occurrence of the problem.","example":"/api/v1/enquiries","type":"string"},"status":{"description":"The HTTP status code.","example":400,"format":"int32","type":"integer"},"title":{"description":"A short, human-readable summary of the problem type.","example":"One or more validation errors occurred.","type":"string"},"type":{"$ref":"#/components/schemas/problemDetailsType"}},"type":"object"}},"components/schemas/validationProblemDetails":{"id":"components/schemas/validationProblemDetails","kind":"json-schema","title":"validationProblemDetails","data":{"additionalProperties":true,"description":"A validation error response that extends ProblemDetails with field-level errors.","properties":{"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"Validation failed for one or more fields.","type":"string"},"errors":{"$ref":"#/components/schemas/validationErrors"},"instance":{"description":"A URI reference that identifies the specific occurrence of the problem.","example":"/api/v1/enquiries","type":"string"},"status":{"description":"The HTTP status code.","example":400,"format":"int32","type":"integer"},"title":{"description":"A short, human-readable summary of the problem type.","example":"One or more validation errors occurred.","type":"string"},"type":{"$ref":"#/components/schemas/problemDetailsType"}},"type":"object"}},"components/schemas/pagination":{"id":"components/schemas/pagination","kind":"json-schema","title":"pagination","data":{"description":"Pagination navigation details","properties":{"next":{"description":"Link to next page of results","example":"/v1/enquiries?cursor=MmFhZjkwMjktOWFhYS00OGM0LWFlNDgtZWI1ZDliMWIzOTEyfDIwMjUtMDctMDlUMTQ6MDU6MzYuNzQ0MTUzMCswMDowMA==&isBackwards=false&pageSize=10","nullable":true,"type":"string"},"previous":{"description":"Link to previous page of results","example":"/v1/enquiries?cursor=MmFhZjkwMjktOWFhYS00OGM0LWFlNDgtZWI1ZDliMWIzOTEyfDIwMjUtMDctMDlUMTQ6MDU6MzYuNzQ0MTUzMCswMDowMA==&isBackwards=true&pageSize=10","nullable":true,"type":"string"}},"type":"object"}},"components/schemas/coordinates":{"id":"components/schemas/coordinates","kind":"json-schema","title":"coordinates","data":{"description":"Latitude/Longitude coordinates","properties":{"latitude":{"description":"Latitude of the location.","example":51.5074,"format":"float","type":"number"},"longitude":{"description":"Longitude of the location.","example":-0.1278,"format":"float","type":"number"}},"required":["latitude","longitude"],"type":"object"}},"components/schemas/addressFormatted":{"id":"components/schemas/addressFormatted","kind":"json-schema","title":"addressFormatted","data":{"description":"The formatted address. If this is being used to create an enquiry, as much information as possible is desired for reverse-geocoding.","example":"123 Testing Way, Testham, United Kingdom TE57 2DE","maxLength":255,"type":"string"}},"components/schemas/assignedSpecialist":{"id":"components/schemas/assignedSpecialist","kind":"json-schema","title":"assignedSpecialist","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The assigned specialist for this resource. If this is "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"null"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" then no specialist has been assigned yet."},"children":[],"type":"text"}],"type":"paragraph"}],"nullable":true,"properties":{"name":{"description":"The name of the user.","example":"Scott Aberdeigh","type":"string"}},"type":"object"}},"components/schemas/checkInOut":{"id":"components/schemas/checkInOut","kind":"json-schema","title":"checkInOut","data":{"description":"The check-in and check-out dates for this enquiry. ISO-8601 date formats are accepted.","properties":{"checkIn":{"example":"2026-02-03","format":"date","nullable":true,"type":"string"},"checkOut":{"example":"2026-03-10","format":"date","nullable":true,"type":"string","x-on-or-after":"checkIn"}},"required":["checkIn","checkOut"],"type":"object"}},"components/schemas/createEnquiryLocation":{"id":"components/schemas/createEnquiryLocation","kind":"json-schema","title":"createEnquiryLocation","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"There are several methods to provide us with a location. You may either provide us with the address, coordinates or Google "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"place_id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". If you provide an address, we will attempt to reverse geocode this to a latitude and longitude. If this fails we will return a HTTP 400 with the relevant error code."},"children":[],"type":"text"}],"type":"paragraph"}],"properties":{"addressFormatted":{"$ref":"#/components/schemas/addressFormatted"},"coordinates":{"$ref":"#/components/schemas/coordinates"},"googlePlaceId":{"$ref":"#/components/schemas/googlePlaceId"}},"type":"object","x-one-of":["coordinates","googlePlaceId","addressFormatted"]}},"components/schemas/createEnquiryRequest":{"id":"components/schemas/createEnquiryRequest","kind":"json-schema","title":"createEnquiryRequest","data":{"properties":{"checkInOut":{"$ref":"#/components/schemas/checkInOut"},"clientReference":{"$ref":"#/components/schemas/enquiryClientReferenceId"},"enquiryLocation":{"$ref":"#/components/schemas/createEnquiryLocation"},"externalId":{"$ref":"#/components/schemas/enquiryExternalId"},"guestNumbers":{"$ref":"#/components/schemas/guestNumbers"},"guestRequirements":{"$ref":"#/components/schemas/enquiryGuestRequirements"},"leadGuest":{"$ref":"#/components/schemas/leadGuestDetails"},"clientBooker":{"$ref":"#/components/schemas/clientBooker"}},"required":["externalId","clientReference","enquiryLocation","checkInOut","guestNumbers","leadGuest","clientBooker"],"type":"object"}},"components/schemas/enquiry":{"id":"components/schemas/enquiry","kind":"json-schema","title":"enquiry","data":{"properties":{"xeniaReference":{"$ref":"#/components/schemas/enquiryXeniaReferenceId"},"clientReference":{"$ref":"#/components/schemas/enquiryClientReferenceId"},"assignedSpecialist":{"$ref":"#/components/schemas/assignedSpecialist"},"checkInOut":{"$ref":"#/components/schemas/checkInOut"},"enquiryLocation":{"$ref":"#/components/schemas/enquiryLocation"},"enquiryState":{"$ref":"#/components/schemas/enquiryState"},"externalId":{"$ref":"#/components/schemas/enquiryExternalId"},"guestNumbers":{"$ref":"#/components/schemas/guestNumbers"},"guestRequirements":{"$ref":"#/components/schemas/enquiryGuestRequirements"},"leadGuest":{"$ref":"#/components/schemas/leadGuestDetails"},"clientBooker":{"$ref":"#/components/schemas/clientBooker"},"createdAt":{"$ref":"#/components/schemas/utcTimestamp"}},"required":["externalId","clientReference","xeniaReference","enquiryState","enquiryLocation","checkInOut","guestNumbers","leadGuest","clientBooker","guestRequirements","assignedSpecialist","createdAt"],"type":"object"}},"components/schemas/enquiryAddress":{"id":"components/schemas/enquiryAddress","kind":"json-schema","title":"enquiryAddress","data":{"description":"The enquiries location.","properties":{"country":{"description":"The country of the location.","example":"United Kingdom","maxLength":280,"nullable":true,"type":"string"},"locality":{"description":"The area, neighbourhood or city of the location.","example":"Hackney","maxLength":280,"nullable":true,"type":"string"},"postalCode":{"description":"The postcode of the location.","example":"BS11 1DJ","maxLength":280,"nullable":true,"type":"string"},"region":{"description":"The region of the location.","example":"Somerset","maxLength":280,"nullable":true,"type":"string"},"streetAddress":{"description":"Street address of the location.","example":"123 fake street","maxLength":280,"nullable":true,"type":"string"}},"type":"object"}},"components/schemas/enquiryGuestRequirements":{"id":"components/schemas/enquiryGuestRequirements","kind":"json-schema","title":"enquiryGuestRequirements","data":{"description":"The guest requirements for the enquiry.","items":{"$ref":"#/components/schemas/enquiryGuestRequirementsItem"},"type":"array"}},"components/schemas/enquiryGuestRequirementsItem":{"id":"components/schemas/enquiryGuestRequirementsItem","kind":"json-schema","title":"enquiryGuestRequirementsItem","data":{"description":"A set of classified requirements for the enquiry.","properties":{"text":{"description":"The requirements in text format for the chosen type.","example":"Security guard mandatory in lobby, double locks required on apartment door","maxLength":10000,"minLength":3,"type":"string"},"type":{"$ref":"#/components/schemas/enquiryGuestRequirementsType"}},"required":["type","text"],"type":"object"}},"components/schemas/enquiryGuestRequirementsType":{"id":"components/schemas/enquiryGuestRequirementsType","kind":"json-schema","title":"enquiryGuestRequirementsType","data":{"enum":["GENERAL"],"example":"GENERAL","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The type of guest requirement. For now only "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"GENERAL"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is supported, but more specific types will be added in the future."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string"}},"components/schemas/enquiryLocation":{"id":"components/schemas/enquiryLocation","kind":"json-schema","title":"enquiryLocation","data":{"properties":{"address":{"$ref":"#/components/schemas/enquiryAddress"},"coordinates":{"$ref":"#/components/schemas/coordinates"},"googlePlaceId":{"$ref":"#/components/schemas/googlePlaceId"}},"required":["coordinates","googlePlaceId","address"],"type":"object"}},"components/schemas/enquiryResponse":{"id":"components/schemas/enquiryResponse","kind":"json-schema","title":"enquiryResponse","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The enquiry response, with the enquiry contained within the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"data"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" object to preserve the root namespace for future API additions."},"children":[],"type":"text"}],"type":"paragraph"}],"properties":{"data":{"$ref":"#/components/schemas/enquiry"}},"required":["data"],"type":"object"}},"components/schemas/enquiryState":{"id":"components/schemas/enquiryState","kind":"json-schema","title":"enquiryState","data":{"description":"Metadata about the enquiry state. This is not always available and may be null.","nullable":true,"properties":{"closureReason":{"$ref":"#/components/schemas/enquiryStateClosureReason"},"state":{"$ref":"#/components/schemas/enquiryStateValue"}},"type":"object"}},"components/schemas/enquiryStateValue":{"id":"components/schemas/enquiryStateValue","kind":"json-schema","title":"enquiryStateValue","data":{"description":"This is a machine-readable key that can be used to identify the state of the enquiry.","enum":["NEW","SHORTLISTING","QUOTED","CLOSED","BOOKING_PENDING","BOOKING_CONFIRMED","BOOKING_CHECK_IN_DETAILS_SENT","BOOKING_CANCELLED"],"example":"CLOSED","type":"string"}},"components/schemas/googlePlaceId":{"id":"components/schemas/googlePlaceId","kind":"json-schema","title":"googlePlaceId","data":{"description":"The Google Place ID of the location.","example":"ChIJN1t_tDeuEmsRUcIaW_4C0gQ","maxLength":255,"type":"string"}},"components/schemas/guestNumbers":{"id":"components/schemas/guestNumbers","kind":"json-schema","title":"guestNumbers","data":{"description":"The number of guests in each category.","properties":{"adults":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The amount of adults (18+ years)."},"children":[],"type":"text"}],"type":"paragraph"}],"example":2,"maximum":99,"minimum":1,"type":"integer"},"children":{"default":0,"description":"The amount of children (1 - 17 years).","example":3,"maximum":99,"type":"integer"},"infants":{"default":0,"description":"The amount of infants (0 - 1 years).","example":1,"maximum":99,"type":"integer"}},"required":["adults"],"type":"object"}},"components/schemas/leadGuestDetails":{"id":"components/schemas/leadGuestDetails","kind":"json-schema","title":"leadGuestDetails","data":{"description":"Details of the lead guest.","properties":{"contactNumber":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Lead guest contact number. Must be a valid phone number format, including international formats with country codes. Valid characters are 0-9, +, -, (, ), and commas. No letters allowed."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"07556677992","format":"phoneNumber","maxLength":50,"nullable":true,"type":"string"},"email":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Lead guest email. Must contain exactly one @ symbol, no spaces or semicolons, and end with a valid domain (e.g., .com or .co.uk)."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"Sam.Smith@example.com","maxLength":200,"nullable":true,"pattern":"^[^@;\\s]+@[^@.;\\s]+(?:\\.\\w+){1,2}$","type":"string"},"familyName":{"description":"Lead guest family name (surname).","example":"Smith","maxLength":50,"nullable":true,"type":"string"},"givenName":{"description":"Lead guest given name (first name).","example":"Sam","maxLength":50,"nullable":true,"type":"string"}},"type":"object"}},"components/schemas/enquiryWebhookPayload":{"id":"components/schemas/enquiryWebhookPayload","kind":"json-schema","title":"enquiryWebhookPayload","data":{"type":"object","description":"The event payload sent to the specified webhook URL. You are expected to pull the full object from the relevant endpoint.","properties":{"eventType":{"$ref":"#/components/schemas/webhookEvent"},"eventId":{"type":"string","format":"uuid","description":"Unique ID of the event. This can be used as the idempotent key.","example":"123e4567-e89b-12d3-a456-426614174000"},"createdAt":{"type":"string","format":"date-time","description":"When the event was created within Xenia's system.","example":"2026-01-01T15:12:56Z"},"data":{"$ref":"#/components/schemas/enquiryWebhookEventData"}}}},"components/schemas/quotesResponse":{"id":"components/schemas/quotesResponse","kind":"json-schema","title":"quotesResponse","data":{"description":"Paginated quotes response.","properties":{"data":{"description":"Array of quotes.","items":{"$ref":"#/components/schemas/quoteResponse"},"type":"array"},"pagination":{"$ref":"#/components/schemas/pagination"}},"required":["data","pagination"],"type":"object"}},"components/schemas/quoteResponse":{"id":"components/schemas/quoteResponse","kind":"json-schema","title":"quoteResponse","data":{"description":"Quote details.","properties":{"id":{"description":"The unique identifier of the quote.","example":"QT-2024-005678","type":"string"},"xeniaEnquiryReference":{"$ref":"#/components/schemas/enquiryXeniaReferenceId"},"clientEnquiryReference":{"description":"The client's reference for the enquiry.","type":"string","nullable":true,"example":"CLIENT-REF-123"},"createdAt":{"description":"When the quote was created.","example":"2024-07-01T14:30:00Z","format":"date-time","type":"string"},"updatedAt":{"description":"When the quote was last updated.","example":"2024-07-01T15:45:00Z","format":"date-time","type":"string"},"invalidatedAt":{"description":"When the quote was invalidated.","example":"2024-07-02T10:30:00Z","format":"date-time","type":"string","nullable":true},"state":{"$ref":"#/components/schemas/quoteState"},"description":{"type":"string","nullable":true,"description":"The quote description. This is the same data if an email is also sent out.","example":"Quote for 3-night stay in London"},"items":{"description":"The quote items (properties and pricing).","items":{"$ref":"#/components/schemas/quoteItem"},"type":"array"},"bookedQuoteItem":{"$ref":"#/components/schemas/bookedQuoteItem"}},"required":["id","xeniaEnquiryReference","clientEnquiryReference","invalidatedAt","bookedQuoteItem","state","description","createdAt","updatedAt","items"],"type":"object"}},"components/schemas/quoteItem":{"id":"components/schemas/quoteItem","kind":"json-schema","title":"quoteItem","data":{"description":"Individual property option within a quote.","properties":{"id":{"description":"The unique id of the quote option item.","example":"4e67c3eb-912a-4da2-91e9-dba4d8e2437e","type":"string"},"property":{"$ref":"#/components/schemas/property"},"distanceFromEnquiryLocation":{"$ref":"#/components/schemas/distanceFromEnquiryLocation"},"booked":{"description":"Indicates whether the quote item is booked.","type":"boolean","example":false}},"required":["id","property"],"type":"object"}},"components/schemas/additionalCharge":{"id":"components/schemas/additionalCharge","kind":"json-schema","title":"additionalCharge","data":{"description":"Formatted additional charge information.","properties":{"summary":{"description":"Charge details.","example":"Cleaning fee (per stay)","type":"string"},"chargeFormat":{"$ref":"#/components/schemas/chargeFormat"},"vat":{"$ref":"#/components/schemas/vat"},"chargeFrequency":{"$ref":"#/components/schemas/chargeFrequency"},"chargedPerGuest":{"description":"Whether the fee is charged per guest.","type":"boolean","example":true},"commisionable":{"description":"Whether the fee is commisionable.","type":"boolean","example":true},"refundable":{"description":"Whether the fee is refundable.","type":"boolean","example":true},"grossCost":{"description":"Formatted total cost including tax.","example":40,"type":"number","nullable":true}},"required":["summary","grossCost"],"type":"object"}},"components/schemas/chargeFrequency":{"id":"components/schemas/chargeFrequency","kind":"json-schema","title":"chargeFrequency","data":{"description":"Indicates whether this is a percentage or absolute charge.","type":"string","enum":["ONE_OFF","NIGHTLY","WEEKLY","MONTHLY"],"example":"ONE_OFF"}},"components/schemas/chargeFormat":{"id":"components/schemas/chargeFormat","kind":"json-schema","title":"chargeFormat","data":{"type":"object","properties":{"chargeFormatType":{"$ref":"#/components/schemas/chargeFormatType"},"rate":{"description":"The amount or percentage.","type":"number","example":10.5,"nullable":true}}}},"components/schemas/chargeFormatType":{"id":"components/schemas/chargeFormatType","kind":"json-schema","title":"chargeFormatType","data":{"description":"Indicates whether this is a percentage or absolute charge.","type":"string","enum":["PERCENTAGE_OF_NIGHTLY_RATE","SPECIFIED_RATE"],"example":"SPECIFIED_RATE"}},"components/schemas/vat":{"id":"components/schemas/vat","kind":"json-schema","title":"vat","data":{"description":"Indicates whether this is a percentage or absolute charge.","type":"object","properties":{"vatApplicability":{"$ref":"#/components/schemas/vatApplicability"},"rate":{"description":"The VAT rate percentage - only included if type is 'Included' or 'Not Included'.","type":"number","nullable":true,"example":20}}}},"components/schemas/vatApplicability":{"id":"components/schemas/vatApplicability","kind":"json-schema","title":"vatApplicability","data":{"description":"Indicates whether this is a percentage or absolute charge.","type":"string","enum":["NOT_APPLICABLE","NOT_INCLUDED","INCLUDED"],"example":"INCLUDED"}},"components/schemas/availability":{"id":"components/schemas/availability","kind":"json-schema","title":"availability","data":{"description":"The availability window for a quote item. ISO-8601 date formats are used.","nullable":true,"properties":{"from":{"description":"Start date of availability.","example":"2024-08-15","format":"date","type":"string"},"to":{"description":"End date of availability.","example":"2024-08-20","format":"date","type":"string"},"nights":{"description":"Number of nights available.","example":5,"type":"integer"}},"required":["from","to","nights"],"type":"object"}},"components/schemas/property":{"id":"components/schemas/property","kind":"json-schema","title":"property","data":{"description":"Property details for the quote item.","type":"object","properties":{"propertyName":{"description":"The name of the property.","example":"The Savoy Hotel","type":"string"},"propertyUrl":{"description":"Link to building.","example":"https://core.xenia.staysitu.com/properties/789","format":"uri","type":"string","pattern":"^https:\\/\\/\\S+$"},"locationMapLink":{"description":"Link to google maps.","example":"https://maps.app.goo.gl/ob21JeqFf6rdkLif7","format":"uri","maxLength":1000,"pattern":"^https:\\/\\/\\S+$","type":"string"},"overview":{"description":"Overview of the property.","example":"A luxurious hotel in the heart of London","nullable":true,"type":"string"},"coordinates":{"$ref":"#/components/schemas/coordinates"},"locationOverview":{"description":"Overview of the property location.","example":"Located in Westminster, near major attractions","nullable":true,"type":"string"},"additionalDetails":{"description":"Additional details about the property.","example":"24-hour concierge service, spa facilities","nullable":true,"type":"string"},"termsOfStay":{"description":"Terms and conditions for the stay.","example":"Check-in after 3 PM, check-out before 11 AM. No smoking.","nullable":true,"type":"string"},"images":{"description":"Array of property images.","type":"array","items":{"$ref":"#/components/schemas/image"}},"units":{"description":"Array of unit details for the property.","type":"array","items":{"$ref":"#/components/schemas/unit"}},"address":{"$ref":"#/components/schemas/address"},"features":{"description":"Array of property features.","type":"array","items":{"$ref":"#/components/schemas/feature"}}},"required":["propertyName","propertyUrl","locationMapLink"]}},"components/schemas/paginationOrder":{"id":"components/schemas/paginationOrder","kind":"json-schema","title":"paginationOrder","data":{"description":"Indicates the direction to travel from the cursor, or beginning or end if no cursor specified.","type":"string","enum":["desc","asc"],"example":"desc","default":"desc"}},"components/schemas/quoteListSortField":{"id":"components/schemas/quoteListSortField","kind":"json-schema","title":"quoteListSortField","data":{"description":"Whether we're sorting by created or updated.","type":"string","enum":["createdAt","updatedAt"],"example":"createdAt","default":"createdAt"}},"components/schemas/priceBreakdown":{"id":"components/schemas/priceBreakdown","kind":"json-schema","title":"priceBreakdown","data":{"description":"Price breakdown for the quote item.","type":"object","properties":{"currency":{"description":"The currency of the price breakdown.","example":"GBP","type":"string"},"wholeStay":{"$ref":"#/components/schemas/wholeStayCost"},"perPeriod":{"$ref":"#/components/schemas/perPeriodCost"}},"required":["currency","wholeStay","perPeriod"]}},"components/schemas/wholeStayCost":{"id":"components/schemas/wholeStayCost","kind":"json-schema","title":"wholeStayCost","data":{"description":"The whole stay cost in the specified currency.","type":"object","properties":{"excludingTax":{"description":"The whole stay cost excluding tax.","example":2100,"type":"number","format":"currency"},"includingTax":{"description":"The whole stay cost including tax.","example":2500,"type":"number","format":"currency"},"taxAmount":{"description":"The tax amount applied to the whole stay cost.","example":400,"type":"number","format":"currency"}},"required":["excludingTax","includingTax","taxAmount"]}},"components/schemas/perPeriodCost":{"id":"components/schemas/perPeriodCost","kind":"json-schema","title":"perPeriodCost","data":{"description":"Per period cost breakdown.","type":"object","properties":{"period":{"$ref":"#/components/schemas/pricingPeriod"},"amountsExcludingAdditionalCharges":{"$ref":"#/components/schemas/perPeriodAmounts"}},"required":["period","amountsExcludingAdditionalCharges"]}},"components/schemas/pricingPeriod":{"id":"components/schemas/pricingPeriod","kind":"json-schema","title":"pricingPeriod","data":{"description":"The pricing period type.","type":"string","enum":["NIGHTLY","DAILY"],"example":"NIGHTLY"}},"components/schemas/perPeriodAmounts":{"id":"components/schemas/perPeriodAmounts","kind":"json-schema","title":"perPeriodAmounts","data":{"description":"Per period amounts excluding additional charges.","type":"object","properties":{"excludingTaxWithBookingFee":{"description":"Period cost excluding additional charges and tax, but including booking fees.","example":400,"type":"number","format":"currency"},"includingTaxWithBookingFee":{"description":"Period cost including tax and booking fees, but excluding additional charges.","example":440,"type":"number","format":"currency"}},"required":["excludingTaxWithBookingFee","includingTaxWithBookingFee"]}},"components/schemas/image":{"id":"components/schemas/image","kind":"json-schema","title":"image","data":{"description":"Property image information.","type":"object","properties":{"url":{"description":"Full URL of the image.","example":"https://images.example.com/property/savoy-suite-main.jpg","format":"uri","type":"string"},"caption":{"description":"Caption or description of the image.","example":"Master bedroom with city view","nullable":true,"type":"string"},"ordering":{"description":"Display order of the image.","example":1,"type":"integer"},"default":{"description":"Whether this is the default/primary image.","example":true,"type":"boolean"}},"required":["url","ordering","default"]}},"components/schemas/unit":{"id":"components/schemas/unit","kind":"json-schema","title":"unit","data":{"description":"Unit details within a property.","type":"object","properties":{"unitName":{"description":"The name of the unit.","example":"Deluxe Suite","type":"string"},"numberOfBedrooms":{"description":"Number of bedrooms in the unit.","example":2,"type":"integer"},"numberOfBathrooms":{"description":"Number of bathrooms in the unit.","example":1,"type":"integer"},"maxOccupancy":{"description":"Maximum occupancy for the unit.","example":4,"type":"integer"},"unitSize":{"description":"Size of the unit in square meters.","example":85.5,"type":"number"},"images":{"description":"Array of property images.","type":"array","items":{"$ref":"#/components/schemas/image"}},"features":{"description":"Array of unit features.","type":"array","items":{"$ref":"#/components/schemas/feature"}},"priceBreakdown":{"$ref":"#/components/schemas/priceBreakdown"},"availability":{"$ref":"#/components/schemas/availability"},"additionalCharges":{"description":"Additional charges.","items":{"$ref":"#/components/schemas/additionalCharge"},"type":"array"},"cancellationPolicies":{"description":"Array of cancellation policy texts.","type":"array","items":{"type":"string"},"example":["Free cancellation up to 48 hours before check-in","50% refund between 48-24 hours before check-in","No refund within 24 hours of check-in"]},"notes":{"description":"Client facing notes made by accommodation specialist.","example":"Special amenities included","type":"string"}},"required":["unitName","numberOfBedrooms","numberOfBathrooms","maxOccupancy","unitSize"]}},"components/schemas/address":{"id":"components/schemas/address","kind":"json-schema","title":"address","data":{"description":"Address information.","type":"object","properties":{"line1":{"description":"First line of the address.","example":"123 Main Street","type":"string"},"line2":{"description":"Second line of the address.","example":"Apartment 4B","nullable":true,"type":"string"},"townCity":{"description":"Town or city.","example":"London","type":"string"},"region":{"description":"Region or state.","example":"Greater London","nullable":true,"type":"string"},"countryCode":{"description":"ISO 3166-1 alpha-2 country code.","example":"GB","type":"string"},"country":{"description":"Country name.","example":"United Kingdom","type":"string"},"postcode":{"description":"Postal code.","example":"SW1A 1AA","nullable":true,"type":"string"}},"required":["line1","townCity","countryCode","country"]}},"components/schemas/feature":{"id":"components/schemas/feature","kind":"json-schema","title":"feature","data":{"description":"Property or unit feature.","type":"object","properties":{"key":{"description":"Feature identifier key.","example":"FACILITIES_INTERNET_SUPER_FAST_WIFI","type":"string"},"description":{"description":"Human-readable feature description.","example":"Internet Connection - Superfast Wi-Fi","type":"string"},"category":{"description":"Feature category.","example":"Facilities","type":"string"},"subCategory":{"description":"Feature sub-category.","example":"Internet","type":"string"},"availability":{"$ref":"#/components/schemas/featureAvailability"},"measurableUnitValue":{"description":"Value for measurable features (e.g., speed, size)","example":"100 Mbps","nullable":true,"type":"string"}},"required":["key","description","category","subCategory","availability"]}},"components/schemas/featureAvailability":{"id":"components/schemas/featureAvailability","kind":"json-schema","title":"featureAvailability","data":{"description":"Availability status of the feature.","type":"string","enum":["IMPLICIT","SUPPLIED","ON_REQUEST","CONSIDERED","NOT_AVAILABLE"],"example":"IMPLICIT"}},"components/schemas/enquiryExternalIdFilter":{"id":"components/schemas/enquiryExternalIdFilter","kind":"json-schema","title":"enquiryExternalIdFilter","data":{"description":"The external ID of the enquiry, this is a unique value that can be used to retrieve your enquiry via other endpoints where specified.","example":"e234abcef","maxLength":255,"minLength":3,"type":"string","nullable":true,"default":"null"}},"components/schemas/quoteState":{"id":"components/schemas/quoteState","kind":"json-schema","title":"quoteState","data":{"description":"The current state of the quote. An active quote can be booked, an invalidated quote cannot be booked. If a new quote is sent out, all existing quotes will become invalidated.","type":"string","enum":["ACTIVE","INVALIDATED"],"example":"ACTIVE"}},"components/schemas/quoteWebhookPayload":{"id":"components/schemas/quoteWebhookPayload","kind":"json-schema","title":"quoteWebhookPayload","data":{"type":"object","description":"The event payload sent to the specified webhook URL. You are expected to pull the full object from the relevant endpoint.","properties":{"eventType":{"$ref":"#/components/schemas/webhookEvent"},"eventId":{"type":"string","format":"uuid","description":"Unique ID of the event. This can be used as the idempotent key.","example":"123e4567-e89b-12d3-a456-426614174000"},"createdAt":{"type":"string","format":"date-time","description":"When the event was created within Xenia's system.","example":"2026-01-01T15:12:56Z"},"data":{"$ref":"#/components/schemas/quoteWebhookEventData"}}}},"components/schemas/quoteWebhookEventData":{"id":"components/schemas/quoteWebhookEventData","kind":"json-schema","title":"quoteWebhookEventData","data":{"type":"object","description":"The data object for a booking event.","properties":{"externalId":{"description":"The unique identifier of the quote.","example":"QT-2024-005678","type":"string"},"createdAt":{"$ref":"#/components/schemas/utcTimestamp"},"invalidatedAt":{"type":"string","format":"date-time","description":"When the quote was invalidated.","example":"2026-01-01T16:45:30Z","nullable":true},"enquiry":{"$ref":"#/components/schemas/enquiryWebhookEventData"}},"required":["externalId","createdAt","enquiry","invalidatedAt"]}},"components/schemas/distanceFromEnquiryLocation":{"id":"components/schemas/distanceFromEnquiryLocation","kind":"json-schema","title":"distanceFromEnquiryLocation","data":{"description":"Distance information from the search location.","type":"object","nullable":true,"properties":{"value":{"description":"The distance value.","type":"number","format":"decimal","example":12.5},"unit":{"$ref":"#/components/schemas/distanceUnit"}},"required":["value","unit"]}},"components/schemas/distanceUnit":{"id":"components/schemas/distanceUnit","kind":"json-schema","title":"distanceUnit","data":{"description":"The unit of measurement for distance.","type":"string","enum":["KILOMETERS"],"example":"KILOMETERS"}},"components/schemas/bookedQuoteItem":{"id":"components/schemas/bookedQuoteItem","kind":"json-schema","title":"bookedQuoteItem","data":{"description":"Information about the quote item that selected for booking. Null if booking is not yet confirmed.","type":"object","nullable":true,"properties":{"bookingId":{"description":"The unique identifier of the booking.","type":"string","example":"BK-2024-123456"},"quoteItemId":{"description":"The unique identifier of the quote item that was booked.","type":"string","example":"4e67c3eb-912a-4da2-91e9-dba4d8e2437e"},"createdAt":{"description":"When the booking was created.","type":"string","format":"date-time","example":"2024-07-02T09:30:00Z"}},"required":["bookingId","quoteItemId","createdAt"]}},"components/schemas/sandboxEnquiryChangeStateRequest":{"id":"components/schemas/sandboxEnquiryChangeStateRequest","kind":"json-schema","title":"sandboxEnquiryChangeStateRequest","data":{"properties":{"closureReason":{"$ref":"#/components/schemas/enquiryStateClosureReason"},"enquiryState":{"$ref":"#/components/schemas/sandboxEnquiryStateValueUpdate"}},"required":["enquiryState"],"type":"object"}},"components/schemas/sandboxEnquiryStateValueUpdate":{"id":"components/schemas/sandboxEnquiryStateValueUpdate","kind":"json-schema","title":"sandboxEnquiryStateValueUpdate","data":{"description":"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","type":"string"}},"components/schemas/sandboxEnquiryTriggerWebhookEventRequest":{"id":"components/schemas/sandboxEnquiryTriggerWebhookEventRequest","kind":"json-schema","title":"sandboxEnquiryTriggerWebhookEventRequest","data":{"properties":{"eventType":{"$ref":"#/components/schemas/webhookEvent"}},"required":["eventType"],"type":"object"}},"components/schemas/createOrUpdateWebhookRequest":{"id":"components/schemas/createOrUpdateWebhookRequest","kind":"json-schema","title":"createOrUpdateWebhookRequest","data":{"properties":{"description":{"description":"A description of the webhook. This is for your own reference and will not be used by Situ.","example":"Webhook for new enquiries","type":"string"},"events":{"description":"The events to subscribe to. This is a list of events that will trigger the webhook. You may subscribe to multiple events. If left empty, all events will be sent.","items":{"$ref":"#/components/schemas/webhookEvent"},"type":"array"},"url":{"description":"The URL to send the webhook to. Xenia will send a POST request to this URL with the event data in the body. The URL must be unique.","example":"https://example.com/webhook","format":"uri","type":"string"}},"required":["url","description"],"type":"object"}},"components/schemas/webhookObject":{"id":"components/schemas/webhookObject","kind":"json-schema","title":"webhookObject","data":{"properties":{"description":{"description":"A description of the webhook. This is for your own reference and will not be used by Situ.","example":"Webhook for new enquiries","type":"string"},"events":{"description":"The events to subscribe to. This is a list of events that will trigger the webhook. You may subscribe to multiple events. If left empty, all events will be sent.","items":{"$ref":"#/components/schemas/webhookEvent"},"type":"array"},"id":{"description":"The ID of the webhook. This is a unique value that can be used to retrieve your webhook via other endpoints where specified.","example":"123e4567-e89b-12d3-a456-426614174000","format":"uuid","type":"string"},"url":{"description":"The URL to send the webhook to. Xenia will send a POST request to this URL with the event data in the body. The URL must be unique for each webhook.","example":"https://example.com/webhook","format":"uri","type":"string"}},"required":["url","description"],"type":"object"}},"components/schemas/webhookResponse":{"id":"components/schemas/webhookResponse","kind":"json-schema","title":"webhookResponse","data":{"description":"The webhook response wrapped in a data object.","properties":{"data":{"$ref":"#/components/schemas/webhookObject"}},"type":"object"}},"components/schemas/webhooksResponse":{"id":"components/schemas/webhooksResponse","kind":"json-schema","title":"webhooksResponse","data":{"description":"The webhook response wrapped in a data object.","properties":{"data":{"description":"A list of webhooks","items":{"$ref":"#/components/schemas/webhookObject"},"type":"array"}},"type":"object"}},"components/schemas/webhookPublicKeyObject":{"id":"components/schemas/webhookPublicKeyObject","kind":"json-schema","title":"webhookPublicKeyObject","data":{"description":"The public key object for webhook signature verification.","properties":{"publicKey":{"description":"The public key in base64 format used to verify webhook signatures.","example":"MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA1234...","type":"string"},"algorithm":{"description":"The algorithm used for signature generation.","example":"HMAC-SHA256","type":"string"},"keyFormat":{"description":"The format of the public key.","example":"base64","type":"string"}},"required":["publicKey","algorithm","keyFormat"],"type":"object"}},"components/schemas/webhookPublicKeyResponse":{"id":"components/schemas/webhookPublicKeyResponse","kind":"json-schema","title":"webhookPublicKeyResponse","data":{"description":"The public key response for webhook signature verification.","properties":{"data":{"$ref":"#/components/schemas/webhookPublicKeyObject"}},"required":["data"],"type":"object"}},"schema_0":{"kind":"json-schema","data":{"type":"string","example":"dGhpcyBpcyBhIHNhbXBsZSBzaWduYXR1cmU="},"id":"schema_0"},"schema_1":{"kind":"json-schema","data":{"type":"string"},"id":"schema_1"},"schema_2":{"kind":"json-schema","data":{"nullable":true,"type":"string","default":"null"},"id":"schema_2"},"schema_3":{"kind":"json-schema","data":{"default":10,"minimum":1,"maximum":100,"type":"integer"},"id":"schema_3"},"schema_4":{"kind":"json-schema","data":{"$ref":"#/components/schemas/paginationOrder"},"id":"schema_4"},"schema_5":{"kind":"json-schema","data":{"$ref":"#/components/schemas/quoteListSortField"},"id":"schema_5"},"schema_6":{"kind":"json-schema","data":{"$ref":"#/components/schemas/enquiryExternalIdFilter"},"id":"schema_6"},"schema_7":{"kind":"json-schema","data":{"format":"uuid","type":"string"},"id":"schema_7"}},"exampleStore":{"paths/booking-pending-event/post/requestBody/content/application~1json/example":{"value":{"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":{"externalId":"e234abcef","clientReference":"example-ref-567abc","xeniaReference":"R4E2F3A4","createdAt":"2026-01-01T15:10:13Z"}}},"id":"paths/booking-pending-event/post/requestBody/content/application~1json/example"},"paths/booking-partner-confirmation-details-sent-event/post/requestBody/content/application~1json/example":{"value":{"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":{"externalId":"e234abcef","clientReference":"example-ref-567abc","xeniaReference":"R4E2F3A4","createdAt":"2026-01-01T15:10:13Z"}}},"id":"paths/booking-partner-confirmation-details-sent-event/post/requestBody/content/application~1json/example"},"paths/booking-client-confirmation-details-sent-event/post/requestBody/content/application~1json/example":{"value":{"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":{"externalId":"e234abcef","clientReference":"example-ref-567abc","xeniaReference":"R4E2F3A4","createdAt":"2026-01-01T15:10:13Z"}}},"id":"paths/booking-client-confirmation-details-sent-event/post/requestBody/content/application~1json/example"},"paths/booking-check-in-details-sent-event/post/requestBody/content/application~1json/example":{"value":{"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":{"externalId":"e234abcef","clientReference":"example-ref-567abc","xeniaReference":"R4E2F3A4","createdAt":"2026-01-01T15:10:13Z"}}},"id":"paths/booking-check-in-details-sent-event/post/requestBody/content/application~1json/example"},"paths/booking-cancelled-event/post/requestBody/content/application~1json/example":{"value":{"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":{"externalId":"e234abcef","clientReference":"example-ref-567abc","xeniaReference":"R4E2F3A4","createdAt":"2026-01-01T15:10:13Z"}}},"id":"paths/booking-cancelled-event/post/requestBody/content/application~1json/example"},"paths/~1external-api~1v1~1enquiries/post/responses/400/content/application~1problem+json/example":{"value":{"detail":"Validation failed for one or more fields.","errors":{"clientReference":["Client reference must be at least 3 characters."],"id":["The externalId field is required."]},"instance":"/external-api/v1/enquiries","status":400,"title":"One or more validation errors occurred.","type":"VALIDATION_ERROR"},"id":"paths/~1external-api~1v1~1enquiries/post/responses/400/content/application~1problem+json/example"},"paths/~1external-api~1v1~1enquiries~1{id}/get/responses/404/content/application~1problem+json/example":{"value":{"detail":"The requested enquiry was not found, please ensure you are using the correct Xenia reference or your own external ID.","instance":"id","status":404,"title":"Resource Not Found","type":"RESOURCE_NOT_FOUND"},"id":"paths/~1external-api~1v1~1enquiries~1{id}/get/responses/404/content/application~1problem+json/example"},"paths/enquiry-created-event/post/requestBody/content/application~1json/example":{"value":{"eventType":"ENQUIRY.CREATED","eventId":"123e4567-e89b-12d3-a456-426614174000","createdAt":"2026-01-01T15:12:56Z","data":{"externalId":"e234abcef","clientReference":"example-ref-567abc","xeniaReference":"R4E2F3A4","createdAt":"2026-01-01T15:10:13Z"}},"id":"paths/enquiry-created-event/post/requestBody/content/application~1json/example"},"paths/enquiry-shortlisting-event/post/requestBody/content/application~1json/example":{"value":{"eventType":"ENQUIRY.SHORTLISTING","eventId":"123e4567-e89b-12d3-a456-426614174000","createdAt":"2026-01-01T15:34:30Z","data":{"externalId":"e234abcef","clientReference":"example-ref-567abc","xeniaReference":"R4E2F3A4","createdAt":"2026-01-01T15:10:13Z"}},"id":"paths/enquiry-shortlisting-event/post/requestBody/content/application~1json/example"},"paths/enquiry-specialist-assigned-event/post/requestBody/content/application~1json/example":{"value":{"eventType":"ENQUIRY.SPECIALIST_ASSIGNED","eventId":"123e4567-e89b-12d3-a456-426614174000","createdAt":"2026-01-01T15:23:00Z","data":{"externalId":"e234abcef","clientReference":"example-ref-567abc","xeniaReference":"R4E2F3A4","createdAt":"2026-01-01T15:10:13Z"}},"id":"paths/enquiry-specialist-assigned-event/post/requestBody/content/application~1json/example"},"paths/enquiry-quoted-event/post/requestBody/content/application~1json/example":{"value":{"eventType":"ENQUIRY.QUOTED","eventId":"123e4567-e89b-12d3-a456-426614174000","createdAt":"2026-01-01T16:15:22Z","data":{"externalId":"e234abcef","clientReference":"example-ref-567abc","xeniaReference":"R4E2F3A4","createdAt":"2026-01-01T15:10:13Z"}},"id":"paths/enquiry-quoted-event/post/requestBody/content/application~1json/example"},"paths/enquiry-closed-event/post/requestBody/content/application~1json/example":{"value":{"eventType":"ENQUIRY.CLOSED","eventId":"123e4567-e89b-12d3-a456-426614174000","createdAt":"2026-01-01T17:23:41Z","data":{"externalId":"e234abcef","clientReference":"example-ref-567abc","xeniaReference":"R4E2F3A4","createdAt":"2026-01-01T15:10:13Z"}},"id":"paths/enquiry-closed-event/post/requestBody/content/application~1json/example"},"paths/enquiry-reopened-event/post/requestBody/content/application~1json/example":{"value":{"eventType":"ENQUIRY.REOPENED","eventId":"123e4567-e89b-12d3-a456-426614174000","createdAt":"2026-01-01T18:45:12Z","data":{"externalId":"e234abcef","clientReference":"example-ref-567abc","xeniaReference":"R4E2F3A4","createdAt":"2026-01-01T15:10:13Z"}},"id":"paths/enquiry-reopened-event/post/requestBody/content/application~1json/example"},"paths/~1external-api~1v1~1quotes/get/responses/200/content/application~1json/example":{"value":{"data":[{"id":"5fa4be11-f6ac-4ba3-9afb-64c52c9420ba","xeniaEnquiryReference":"R4E2F3A4","clientEnquiryReference":"CLIENT-REF-123","createdAt":"2024-07-01T14:30:00Z","updatedAt":"2024-07-01T15:45:00Z","invalidatedAt":null,"description":"Quote for 3-night stay in London","state":"ACTIVE","bookedQuoteItem":{"bookingId":"BK-2024-123456","quoteItemId":"4e67c3eb-912a-4da2-91e9-dba4d8e2437e","createdAt":"2024-07-02T09:30:00Z"},"items":[{"id":"4e67c3eb-912a-4da2-91e9-dba4d8e2437e","booked":true,"property":{"propertyName":"The Savoy Hotel","propertyUrl":"https://core.xenia.staysitu.com/properties/789","locationMapLink":"https://maps.app.goo.gl/ob21JeqFf6rdkLif7","overview":"A luxurious hotel in the heart of London","coordinates":{"latitude":51.5074,"longitude":-0.1278},"locationOverview":"Located in Westminster, near major attractions","additionalDetails":"24-hour concierge service, spa facilities","termsOfStay":"Check-in after 3 PM, check-out before 11 AM. No smoking.","images":[{"url":"https://images.example.com/property/savoy-suite-main.jpg","caption":"Master bedroom with city view","ordering":1,"default":true},{"url":"https://images.example.com/property/savoy-bathroom.jpg","caption":"Luxury marble bathroom","ordering":2,"default":false},{"url":"https://images.example.com/property/savoy-living.jpg","caption":"Spacious living area","ordering":3,"default":false}],"units":[{"unitName":"Deluxe Suite","numberOfBedrooms":2,"numberOfBathrooms":1,"maxOccupancy":4,"unitSize":85.5,"images":[{"url":"https://images.example.com/property/deluxe-suite-bedroom.jpg","caption":"Deluxe Suite master bedroom","ordering":1,"default":true},{"url":"https://images.example.com/property/deluxe-suite-bathroom.jpg","caption":"Deluxe Suite bathroom","ordering":2,"default":false}],"priceBreakdown":{"currency":"GBP","wholeStay":{"excludingTax":2100,"includingTax":2500,"taxAmount":400},"perPeriod":{"period":"NIGHTLY","amountsExcludingAdditionalCharges":{"excludingTaxWithBookingFee":400,"includingTaxWithBookingFee":440}}},"availability":{"from":"2024-08-15","to":"2024-08-20","nights":5},"additionalCharges":[{"summary":"Cleaning fee (per stay)","grossCost":40,"chargeFormat":{"chargeFormatType":"SPECIFIED_RATE","rate":40},"vat":{"vatApplicability":"INCLUDED","rate":null},"chargeFrequency":"ONE_OFF","chargedPerGuest":false,"commisionable":true,"refundable":false}],"cancellationPolicies":["Free cancellation up to 48 hours before check-in","50% refund between 48-24 hours before check-in"]},{"unitName":"Executive Suite","numberOfBedrooms":3,"numberOfBathrooms":2,"maxOccupancy":6,"unitSize":120,"images":[{"url":"https://images.example.com/property/executive-suite-living.jpg","caption":"Executive Suite living area","ordering":1,"default":true},{"url":"https://images.example.com/property/executive-suite-bedroom.jpg","caption":"Executive Suite master bedroom","ordering":2,"default":false}],"priceBreakdown":{"currency":"GBP","wholeStay":{"excludingTax":3500,"includingTax":4200,"taxAmount":700},"perPeriod":{"period":"NIGHTLY","amountsExcludingAdditionalCharges":{"excludingTaxWithBookingFee":700,"includingTaxWithBookingFee":840}}},"availability":{"from":"2024-08-15","to":"2024-08-20","nights":5},"additionalCharges":[{"summary":"Cleaning fee (per stay)","grossCost":60,"chargeFormat":{"chargeFormatType":"SPECIFIED_RATE","rate":60},"vat":{"vatApplicability":"INCLUDED","rate":null},"chargeFrequency":"ONE_OFF","chargedPerGuest":false,"commisionable":true,"refundable":false}],"cancellationPolicies":["Free cancellation up to 48 hours before check-in","No refund within 24 hours of check-in"]}]}}]}],"pagination":{"next":"/external-api/v1/quotes?cursor=NWZhNGJlMTEtZjZhYy00YmEzLTlhZmItNjRjNTJjOTQyMGJhfDIwMjQtMDctMDFUMTU6NDU6MDBafE5leHQ=&pageSize=10&order=DESCENDING&sort=createdAt","previous":null}},"id":"paths/~1external-api~1v1~1quotes/get/responses/200/content/application~1json/example"},"paths/~1external-api~1v1~1quotes/get/responses/404/content/application~1problem+json/example":{"value":{"detail":"The requested quote was not found, please ensure you are using the correct Xenia external ID.","instance":"id","status":404,"title":"Resource Not Found","type":"RESOURCE_NOT_FOUND"},"id":"paths/~1external-api~1v1~1quotes/get/responses/404/content/application~1problem+json/example"},"paths/quote-created-event/post/requestBody/content/application~1json/example":{"value":{"eventType":"QUOTE.CREATED","eventId":"123e4567-e89b-12d3-a456-426614174000","createdAt":"2026-01-01T15:12:56Z","data":{"externalId":"QT-2024-005678","invalidatedAt":null,"createdAt":"2026-01-01T15:10:13Z","enquiry":{"externalId":"e234abcef","clientReference":"example-ref-567abc","xeniaReference":"R4E2F3A4","createdAt":"2026-01-01T15:10:13Z"}}},"id":"paths/quote-created-event/post/requestBody/content/application~1json/example"},"paths/quote-invalidated-event/post/requestBody/content/application~1json/example":{"value":{"eventType":"QUOTE.INVALIDATED","eventId":"123e4567-e89b-12d3-a456-426614174000","createdAt":"2026-01-01T16:45:30Z","data":{"externalId":"QT-2024-005678","invalidatedAt":"2026-01-01T16:45:30Z","createdAt":"2026-01-01T15:10:13Z","enquiry":{"externalId":"e234abcef","clientReference":"example-ref-567abc","xeniaReference":"R4E2F3A4","createdAt":"2026-01-01T15:10:13Z"}}},"id":"paths/quote-invalidated-event/post/requestBody/content/application~1json/example"},"paths/~1external-api~1v1~1sandbox~1enquiries~1{id}~1change-state/post/requestBody/content/application~1json/example":{"value":{"enquiryState":"CLOSED"},"id":"paths/~1external-api~1v1~1sandbox~1enquiries~1{id}~1change-state/post/requestBody/content/application~1json/example"},"paths/~1external-api~1v1~1sandbox~1enquiries~1{id}~1change-state/post/responses/404/content/application~1problem+json/example":{"value":{"detail":"The requested enquiry was not found, please ensure you are using the correct Xenia reference or your own external ID.","instance":"id","status":404,"title":"Resource Not Found","type":"RESOURCE_NOT_FOUND"},"id":"paths/~1external-api~1v1~1sandbox~1enquiries~1{id}~1change-state/post/responses/404/content/application~1problem+json/example"},"paths/~1external-api~1v1~1sandbox~1enquiries~1{id}~1trigger-webhook-event/post/requestBody/content/application~1json/example":{"value":{"eventType":"ENQUIRY.CREATED"},"id":"paths/~1external-api~1v1~1sandbox~1enquiries~1{id}~1trigger-webhook-event/post/requestBody/content/application~1json/example"},"paths/~1external-api~1v1~1sandbox~1enquiries~1{id}~1trigger-webhook-event/post/responses/404/content/application~1problem+json/example":{"value":{"detail":"The requested enquiry was not found, please ensure you are using the correct Xenia reference or your own external ID.","instance":"id","status":404,"title":"Resource Not Found","type":"RESOURCE_NOT_FOUND"},"id":"paths/~1external-api~1v1~1sandbox~1enquiries~1{id}~1trigger-webhook-event/post/responses/404/content/application~1problem+json/example"},"paths/~1external-api~1v1~1webhooks/get/responses/200/content/application~1json/example":{"value":{"data":[{"description":"Webhook for new enquiries","events":["ENQUIRY.CREATED","ENQUIRY.SHORTLISTING","ENQUIRY.CLOSED"],"id":"123e4567-e89b-12d3-a456-426614174000","url":"https://example.com/lifecycle-webhook"},{"description":"Webhook for assigned specialists","events":["ENQUIRY.SPECIALIST_ASSIGNED"],"id":"123e4567-e89b-12d3-a456-426614174001","url":"https://example.com/assigned-specialists-webhook"}]},"id":"paths/~1external-api~1v1~1webhooks/get/responses/200/content/application~1json/example"},"paths/~1external-api~1v1~1webhooks/get/responses/400/content/application~1problem+json/example":{"value":{"detail":"The request was malformed.","status":400,"title":"Malformed Request","type":"MALFORMED_REQUEST"},"id":"paths/~1external-api~1v1~1webhooks/get/responses/400/content/application~1problem+json/example"},"paths/~1external-api~1v1~1webhooks/get/responses/500/content/application~1problem+json/example":{"value":{"detail":"An error occurred on the server.","status":500,"title":"Internal Server Error","type":"INTERNAL_SERVER_ERROR"},"id":"paths/~1external-api~1v1~1webhooks/get/responses/500/content/application~1problem+json/example"},"paths/~1external-api~1v1~1webhooks/post/requestBody/content/application~1json/example":{"value":{"description":"Webhook for new enquiries","events":["ENQUIRY.CREATED","ENQUIRY.CLOSED"],"url":"https://example.com/webhook"},"id":"paths/~1external-api~1v1~1webhooks/post/requestBody/content/application~1json/example"},"paths/~1external-api~1v1~1webhooks/post/responses/201/content/application~1json/example":{"value":{"data":{"description":"Webhook for new enquiries","events":["ENQUIRY.CREATED","ENQUIRY.CLOSED"],"id":"123e4567-e89b-12d3-a456-426614174000","url":"https://example.com/webhook"}},"id":"paths/~1external-api~1v1~1webhooks/post/responses/201/content/application~1json/example"},"paths/~1external-api~1v1~1webhooks/post/responses/400/content/application~1problem+json/example":{"value":{"detail":"URL is invalid","instance":"/data/url","status":400,"title":"Validation Error","type":"VALIDATION_ERROR"},"id":"paths/~1external-api~1v1~1webhooks/post/responses/400/content/application~1problem+json/example"},"paths/~1external-api~1v1~1webhooks/post/responses/500/content/application~1problem+json/example":{"value":{"detail":"An error occurred on the server.","status":500,"title":"Internal Server Error","type":"INTERNAL_SERVER_ERROR"},"id":"paths/~1external-api~1v1~1webhooks/post/responses/500/content/application~1problem+json/example"},"paths/~1external-api~1v1~1webhooks~1{id}/delete/responses/404/content/application~1problem+json/example":{"value":{"detail":"The webhook was not found.","status":404,"title":"Resource Not Found","type":"RESOURCE_NOT_FOUND"},"id":"paths/~1external-api~1v1~1webhooks~1{id}/delete/responses/404/content/application~1problem+json/example"},"paths/~1external-api~1v1~1webhooks~1{id}/delete/responses/500/content/application~1problem+json/example":{"value":{"detail":"An error occurred on the server.","status":500,"title":"Internal Server Error","type":"INTERNAL_SERVER_ERROR"},"id":"paths/~1external-api~1v1~1webhooks~1{id}/delete/responses/500/content/application~1problem+json/example"},"paths/~1external-api~1v1~1webhooks~1{id}/get/responses/200/content/application~1json/example":{"value":{"data":{"description":"Webhook for new enquiries","events":["ENQUIRY.CREATED","ENQUIRY.CLOSED"],"id":"123e4567-e89b-12d3-a456-426614174000","url":"https://example.com/webhook"}},"id":"paths/~1external-api~1v1~1webhooks~1{id}/get/responses/200/content/application~1json/example"},"paths/~1external-api~1v1~1webhooks~1{id}/get/responses/404/content/application~1problem+json/example":{"value":{"detail":"The webhook was not found.","status":404,"title":"Resource Not Found","type":"RESOURCE_NOT_FOUND"},"id":"paths/~1external-api~1v1~1webhooks~1{id}/get/responses/404/content/application~1problem+json/example"},"paths/~1external-api~1v1~1webhooks~1{id}/get/responses/500/content/application~1problem+json/example":{"value":{"detail":"An error occurred on the server.","status":500,"title":"Internal Server Error","type":"INTERNAL_SERVER_ERROR"},"id":"paths/~1external-api~1v1~1webhooks~1{id}/get/responses/500/content/application~1problem+json/example"},"paths/~1external-api~1v1~1webhooks~1{id}/put/requestBody/content/application~1json/example":{"value":{"description":"Webhook for new enquiries","events":["ENQUIRY.CREATED","ENQUIRY.CLOSED"],"url":"https://example.com/webhook"},"id":"paths/~1external-api~1v1~1webhooks~1{id}/put/requestBody/content/application~1json/example"},"paths/~1external-api~1v1~1webhooks~1{id}/put/responses/200/content/application~1json/example":{"value":{"data":{"description":"Webhook for new enquiries","events":["ENQUIRY.CREATED","ENQUIRY.CLOSED"],"id":"123e4567-e89b-12d3-a456-426614174000","url":"https://example.com/webhook"}},"id":"paths/~1external-api~1v1~1webhooks~1{id}/put/responses/200/content/application~1json/example"},"paths/~1external-api~1v1~1webhooks~1{id}/put/responses/400/content/application~1problem+json/example":{"value":{"detail":"Validation errors occurred within the request body","errors":{"url":["The URL must be a valid URI."]},"status":400,"title":"Validation Error","type":"VALIDATION_ERROR"},"id":"paths/~1external-api~1v1~1webhooks~1{id}/put/responses/400/content/application~1problem+json/example"},"paths/~1external-api~1v1~1webhooks~1{id}/put/responses/404/content/application~1problem+json/example":{"value":{"detail":"The webhook was not found.","status":404,"title":"Resource Not Found","type":"RESOURCE_NOT_FOUND"},"id":"paths/~1external-api~1v1~1webhooks~1{id}/put/responses/404/content/application~1problem+json/example"},"paths/~1external-api~1v1~1webhooks~1{id}/put/responses/500/content/application~1problem+json/example":{"value":{"detail":"An error occurred on the server.","status":500,"title":"Internal Server Error","type":"INTERNAL_SERVER_ERROR"},"id":"paths/~1external-api~1v1~1webhooks~1{id}/put/responses/500/content/application~1problem+json/example"},"paths/~1external-api~1v1~1webhook-verification-key/get/responses/200/content/application~1json/example":{"value":{"data":{"publicKey":"MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA1234...","algorithm":"HMAC-SHA256","keyFormat":"base64"}},"id":"paths/~1external-api~1v1~1webhook-verification-key/get/responses/200/content/application~1json/example"},"paths/~1external-api~1v1~1webhook-verification-key/get/responses/500/content/application~1problem+json/example":{"value":{"detail":"An error occurred on the server.","status":500,"title":"Internal Server Error","type":"INTERNAL_SERVER_ERROR"},"id":"paths/~1external-api~1v1~1webhook-verification-key/get/responses/500/content/application~1problem+json/example"}},"securitySchemeStore":{"apiKey":{"id":"apiKey","type":"apiKey","in":"header","paramName":"X-Api-Key"}},"specVersion":"3.0.3","servers":[{"url":"/_mock/xenia-connect/spec","isMockServer":true,"description":"Mock server"},{"url":"https://api-xenia.staysitu.com","description":"Production"},{"url":"https://api-xenia-cisandbox.staysitu.com","description":"Sandbox"}],"specType":"openapi"},"options":{"mockServer":{"url":"/_mock/xenia-connect/spec","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/xenia-connect/spec.json?download"},{"url":"/_bundle/xenia-connect/spec.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false,"asyncapi":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Xenia Connect API","description":"Situ's API for seamless integration with Situ's workflow."}},"baseSlug":"/xenia-connect/spec","routesMapping":{}}