← All manuals

IBE user manual

Configure and embed a branded Apaleo booking journey, with inventory, services, payments and conversion reporting.

Create an IBE and complete onboarding

Set up properties, content, journey, legal links and payment readiness.

Recommended setup order

  1. Open IBE and select an existing widget or create a new one using an offered creation/template option.
  2. Choose languages and the Apaleo properties to sell, then add property and unit-group descriptions, images and feature icons.
  3. Choose the presentation and booking flow: standard or popup, property or unit mode, services and price display.
  4. Add terms, privacy links and the allowed website origins.
  5. Configure payment settings with the authorized payment administrator, then test the complete booking journey before embedding it publicly.
  6. Reopen Onboarding later to review the setup; use the main editor for detailed settings.

Each IBE ID selects its own saved configuration. Confirm the selected widget before making changes.

Read this article via API

Properties, unit groups, units and content

Choose sellable inventory and maintain the guest-facing information.

Inventory and descriptions

  1. Add the intended properties and choose the unit groups or units offered by the selected mode.
  2. Edit property and unit-group names, descriptions and feature icons. Review every enabled language.
  3. Upload and order images for the intended property or unit group. Preview the image crop and layout before saving.
  4. Use property public-ID mapping when configured to give properties customer-facing identifiers.

Services and availability settings

  1. Review available services and the unit/service mappings that control where they are offered.
  2. Use the rate and restriction editors for the intended property/unit-group/date range when those controls are available.
  3. Verify Apaleo rate plans, occupancy, sellable inventory and restrictions if expected offers are missing.
  4. Check the result with real dates and guest counts after saving.

Images and descriptive content do not create Apaleo availability. Offers still depend on live inventory, rates and restrictions.

Read this article via API

Visual and graphical editors

Adjust layout, typography, colors, imagery and maps in the correct widget.

Edit and preview

  1. Select the widget and language, then open the main or graphical editor.
  2. Set common fonts, background, button colors and section-specific typography and layout.
  3. Adjust property, unit-group, offer and service sections, including widths, heights, images and slideshow/fade behavior where offered.
  4. Review calendar colors, search fields and sort/filter appearance.
  5. For maps, review marker icons, dimensions, text, clustering and info-window styling.
  6. Preview standard and popup layouts on desktop and mobile and save the intended changes.

Custom frontends

  1. Use the custom frontend settings only for a renderer provided for your integration.
  2. Preview its booking behavior before assigning it to a live widget.

A renderer key selects an installed implementation; settings are not a place to upload executable customer code.

Read this article via API

Search fields, filters, prices and booking modes

Control how guests find offers and move through the booking journey.

Search and price display

  1. Choose the search questions and available sort/filter fields.
  2. Review occupancy, adults, children and children’s ages, room count and any enabled unit attributes.
  3. Choose per-night display (yes, no or both), city-tax display and the offered price/filter options.
  4. Run searches with different dates, guest counts and filters and compare the results with Apaleo.

Journey modes

  1. Choose property mode for a property-first journey or unit mode when selecting individual units is intended.
  2. Review Offer Stage Mode for checkout from the offer selection stage.
  3. Review Full List Mode when properties, offers and available extra services should appear together.
  4. Choose whether to skip the extra-service step, open in a new tab, show properties before search or offer alternative dates when available.

Mode combinations affect the guest journey. Test the combination actually used by the host page.

Read this article via API

Guest questions and checkout behavior

Configure guest details and legal information and verify the booking result.

Configure checkout

  1. Open the booking-form question settings and choose the offered fields for the booker and guests, including optional person details.
  2. Review translated question labels, required fields, terms and privacy links.
  3. Test checkout with a primary guest, additional guests and relevant company details.
  4. Inspect the confirmation and any configured reservation modification or cancellation flow using the actual booking context.

A confirmation-looking URL alone does not establish that a booking or payment succeeded. Check the server-backed order and Apaleo reservation.

Read this article via API

Adyen settings and payment troubleshooting

Configure test/live payment details and validate the complete payment return.

Configure payment settings

  1. Select the correct widget and open Payment Settings with an authorized account user.
  2. Choose the intended Adyen environment and enter the API key, client key and live endpoint prefix where required.
  3. Confirm the merchant account code and submerchant ID with Apaleo. Review the allowed-domain instructions shown in the editor.
  4. Make sure the actual booking origin is allowed for both the widget integration and the payment provider.
  5. Run a test payment, including its redirect/return, and verify the resulting reservation and payment status.

Guarantees, invoices and failures

  1. If company invoice booking is enabled, check that the selected offer’s rate plan uses Company guarantee; enabling the option does not make every booking an invoice booking.
  2. If payment fails, record the stage and visible error and inspect whether an order, reservation or payment already exists before retrying.
  3. For a real charge or uncertain payment result, send support the order/reservation IDs and timestamp through the support channel.

Do not place API keys, card details or payment return tokens in support chat. Payment settings and origins need separate review when moving from test to live.

Read this article via API

Widget IDs, allowed origins and website embeds

Publish the correct widget using its generated integration instructions.

Get the correct integration

  1. In Widget Settings, select the saved IBE ID and check its name, languages and presentation.
  2. Copy the generated embed or booking URL from that widget’s instructions; standard, URL and popup integrations have different entry points.
  3. Add every host origin, including protocol, to the allowed origins list. Review www/non-www, staging and production separately.
  4. Insert the generated integration into the host website, then test opening, searching, checkout and the payment return.
  5. For popup integrations, test the trigger button, closing behavior and mobile layout.

Diagnose an embed issue

  1. Open the booking URL directly to separate widget configuration from host-page integration.
  2. Check the IBE ID, script URL, allowed origin and browser errors.
  3. Review host-page CSS/layout and popup behavior when the direct booking URL works.

Copy integration code from your current environment. A test script or test IBE ID should not be assumed to use production settings.

WordPress and website optimizers

  1. Paste the generated snippet into a Custom HTML block; no Simultem WordPress plugin is required.
  2. Replace the script tag as well when updating an existing embed, preserving the generated optimizer-exclusion attributes.
  3. Clear the website’s page and optimization caches once after replacement.
  4. Check that the browser loads the intended hosted widget script. If an editor strips attributes or an unsupported optimizer rewrites the script, configure an explicit exclusion.

The generated snippet includes exclusions for WP Rocket, Cloudflare Rocket Loader, Autoptimize and LiteSpeed Cache. Host analytics and consent remain controlled by the website.

Read this article via API

Extra services and reservation-specific service links

Offer suitable services during booking or through a signed link for an existing reservation.

Offer services

  1. Review service descriptions, pricing and property/unit mappings.
  2. Choose whether the extra-services stage is shown or skipped.
  3. Test service availability and quantities with the relevant dates, occupants and offer selections.

Send a service-booking link

  1. Open Extra-service booking link in Widget Settings and enter the intended Apaleo reservation ID.
  2. Generate the signed link and review any validation error.
  3. Copy or open the resulting link and check that it shows only the intended reservation’s available services.
  4. Send it only to the intended recipient through an approved channel.

The signed link grants access to the reservation’s service flow. Do not substitute a plain reservation ID for the generated authorization.

Read this article via API

Promo codes, Profiles and internal booking

Connect profile context and Bulk promotions to the booking flow.

Review cross-app setup

  1. Configure the relevant IBE options for profile/promo behavior.
  2. For Bulk campaigns, verify the target widget, rate plans and participating properties before distributing links.
  3. When booking from Profiles, check the selected guest and property before using the internal booking action.
  4. Test a profile-aware or promotional link with the intended guest context and check the resulting offer and reservation.

A promo code cannot override an unavailable rate plan or missing inventory.

Read this article via API

Booking reports and host-page conversion tracking

Inspect funnel behavior and integrate booking-completed events with the host site.

Use booking reports

  1. Open the booking reports view and choose the property, dates and language/filters offered.
  2. Review stage counts from landing and search through checkout, payment, success and failure.
  3. Inspect reservation and service amounts when comparing completed bookings.
  4. Compare the same date and property scope before drawing conclusions from funnel counts.

Compare periods, cancellations and campaign results

  1. The built-in reservation query uses the IBE channel and reservation creation-date range. This is different from stay dates, payment dates or task due dates.
  2. The reservation count/amount calculation does not explicitly exclude canceled reservations. Check current source status and amendments before treating these figures as cancellation-adjusted revenue.
  3. For cross-hotel or campaign comparisons, define the date basis, status treatment, currency and refresh point before comparing totals.
  4. These screens do not automatically attribute bookings or task workload to a Bulk campaign. Use an explicit campaign-to-reservation linkage and a defined reporting measure for that analysis.
  5. Use funnel stage counts to locate drop-off. A stage count does not establish the cause of each failure; check the actual booking/payment outcome separately.

Configure website tracking

  1. Open IBE Booking Reports → GA4 & Google Ads setup instructions, also available in onboarding.
  2. In the host website’s GTM container, add a Custom Event trigger named purchase and a GA4 Event tag named purchase with Send Ecommerce data → Data Layer enabled.
  3. For an Ads tag, map ecommerce.value, ecommerce.currency and ecommerce.transaction_id and set your own conversion ID and label.
  4. Test in GTM Preview/GA4 DebugView with a completed test booking.
  5. If using the independent simultem:booking-completed event for custom integration, register the listener before checkout completes and avoid creating a second purchase path.

Events indicate booking creation, including pay-later bookings; they do not prove that every folio payment has been collected.

GA4 value is the full confirmed booking net revenue excluding VAT/city tax, not just today’s deposit. Items represent reservations including booked extras, with quantity 1 per stay. Incomplete financial reconciliation can suppress purchase while the independent completion event remains available.

Host tags and consent control delivery to Google. Do not forward both native purchase and the custom completion signal as duplicate purchases.

Read this article via API

Go-live checks and troubleshooting

Test the complete guest journey and collect reproducible evidence.

Before publishing

  1. Test each property, supported language and main device size.
  2. Check valid and unavailable dates, multiple occupants, children’s ages, rooms and promo codes.
  3. Review images, filters, map, services, required questions and legal links.
  4. Complete a test payment and inspect confirmation and the Apaleo reservation.
  5. Test the host-page integration and conversion tracking, including a payment return.

Locate the failure

  1. For no offers, check selected property/unit groups, live rates, restrictions, occupancy and dates.
  2. For wrong content, verify the IBE ID, language and inventory mappings.
  3. For missing images or broken layout, compare direct and embedded views and inspect browser errors.
  4. For support, include the IBE ID, host URL/origin, dates, occupants, property/unit-group IDs, failing stage and a screenshot/error.
Read this article via API