Aurelia/Docs
Integration surfaces
Open demo

Aurelia docs

Docs/Platform/Integration surfaces

Integration surfaces

Aurelia's prototype surface is already designed to be mounted from product code, host-page JavaScript, or CMS-managed prompt buttons, which makes it practical for large hotel websites with mixed ownership models.

Frontend engineers and technical owners planning site integration.7 min

This page covers

Host APIControl Aurelia from a parent site without managing the assistant internals directly.React exportsUse the existing prototype components when Aurelia is embedded deeper into the product.Page context contractAurelia is only as good as the context it receives from the page.Prompt-surface patternsPlace Aurelia where guest hesitation naturally happens.

Page details

Audience

Frontend engineers and technical owners planning site integration.

Read time

7 min

Focus

Reference the current host API, React exports, page context contract, and prompt-surface patterns.

Host API

Control Aurelia from a parent site without managing the assistant internals directly.

Current prototype host API.

window.PreferredConcierge?.init(config);
window.PreferredConcierge?.open({ prompt, pinnedHotelSlug });
window.PreferredConcierge?.close();
window.PreferredConcierge?.setContext(context);

This surface keeps the host contract small. The host decides where Aurelia appears, what context it gets, and which telemetry events should be captured. The concierge shell owns the conversation loop and rendering.

React exports

Use the existing prototype components when Aurelia is embedded deeper into the product.

Prototype React integration surface.

import {
  PreferredConciergeProvider,
  ConciergeLauncher,
  useConcierge
} from "@/components/concierge-embed";
  • PreferredConciergeProvider mounts the shell and provides state.
  • ConciergeLauncher opens the assistant from product-owned UI with optional prompt context.
  • useConcierge exposes open, close, and page-context controls for custom integration patterns.

Page context contract

Aurelia is only as good as the context it receives from the page.

Representative context fields used by the current prototype.

{
  id: "preferred-hotel",
  pageType: "hotel",
  title: "Hotel detail",
  summary: "Use the concierge for room fit and dining questions.",
  sectionId: "hotel",
  activeSectionId: "dining",
  activeSectionLabel: "Dining",
  pageHotelSlug: "united-states/mark",
  activeHotelSlug: "united-states/mark",
  visibleHotelSlugs: ["united-states/mark"],
  promptSuggestions: ["Dining vibe", "Best room for me", "Late arrival"]
}
Key principle

Page context should describe what the guest is seeing right now, not everything the system knows globally. That keeps answers precise, useful, and easier to reason about.

Prompt-surface patterns

Place Aurelia where guest hesitation naturally happens.

  • Homepage hero for natural-language trip planning.
  • Destination browse cards for fit and compare flows.
  • Hotel detail sections for room, dining, location, and arrival questions.
  • Booking handoff surfaces for final reassurance before rates.
  • Campaign and landing pages via CMS-managed prompts.
PreviousTechnical architectureNextObservability and evaluation