Skip to main content

Widgets

Widgets are small pieces of content that can be added to our platform. They run sandboxed in a iFrame and are able to comunnicate with the platform in different ways. Via the API of directly with the interface via Post Messages.

Widget query parameters

In some widgets we will send over some data to help you identify the object the widget is loaded in. With a reservation this can be the ID of the reservation and with a contact this can be the ID of the contact. E.g. https://example.app/widgets/reservation?id=12345&authtoken=...... These query parameters are described in every widget.

Sending events back to the interface

You are also able to send information back to the interface. Like how high should we make the widget in our interface? Or and command to refresh the object (E.g. reservation, contact) if you have made changes to it via the API. These events are described in every widget.