Koala Smartblock docs

This section is not public yet. Enter the password you received from Koala.

Skip to main content

Glossary

The vocabulary used across this documentation, in one place.

You
The integrator reading these docs: the partner developer or team embedding Koala Smartblock in their pages and backend.
Traveller
The end customer buying the trip and, when they select protection, the person insured.
Bundle
A packaged protection offer shown as one priced option. It is what the traveller selects or declines in the widget.
seeTrip data and pricing
Quote
The price Koala calculates for each configured bundle against one specific trip. The widget requests it at page load, and again after a restart.
seeTrip data and pricing
Subscription
The traveller's policy. Your backend creates it with one HTTP POST after a booking that ends with a sale on your side.
seeCreating the subscription
Deleted quote
What the same POST records when the traveller declined the offer, so Koala measures conversion against all sales, not only the ones that took protection.
seeCreating the subscription
Basketwindow.CTStore.koala.basketPayload
The traveller's current selection state. The widget keeps it up to date and delivers it with each onBasket event.
seeEventsEvents and basket state
Request templatebasketPayload.book
The prepared request (msgRaw and fullUrl) the widget maintains for your backend to fill in and send: it creates the subscription, or deletes the quote.
seeRequest templateCreating the subscription
Trip contextwindow.CTStore.dataSource
The trip data you provide for pricing: currency, language, the trip, and the travellers.
seeTrip contextTrip data and pricing
PlacementdataSource.custom.context
Where in your pages the widget sits, for example checkout, confirmation, or manage my booking. You tell Koala through the trip context.
seePlacements in the traveller journey
Booking number
Your identifier for the booking, unique across your bookings. Only your system knows it, and the subscription request requires it, which is why the call is made after your booking is confirmed.
seeRequest template
Merchant of record
Whoever takes the payment for the protection. It determines whether card details belong in the subscription request.
seeRequest template
Car-rental Smartblock
The CarTrawler widget some booking pages already run. It shares the window.CTStore surface with Koala Smartblock.
seeAlongside the car-rental SmartblockCarTrawler's Smartblock docs
Partner slugdata-config-name
Your identifier, provided by Koala, set on the custom HTML element. It tells the widget which configuration to load.
seeFresh integration
Loader script
The asynchronous script that boots the widget. Its URL determines which Koala environment the widget talks to.
seeWidget loading