Embedding Apps

How to embed Experiences into your products using Monterosa / Interaction SDK

The SDK can be used to embed an app into your web or native app. This provides loading and resizing capabilities which save you integration effort and make for a smooth user experience.

Why Embed with the SDK?

The SDK supports the following use cases:

Launch an Experience or web app with little code
Dynamic resizing and self-managing size based on the needs of the Experience
Displaying or removing headers and footers depending on context
Preloading the Experience (native apps)
Supports sharing storage between your app and the Experience, ensuring a smooth experience for all users even in incognito windows.

You can use our demo pagebuilt with the SDK to see these features in action.

Terminology

When an app is styled, setup and offered up to the audience, we refer to it as an Experience.

For the purposes of embedding integration, an Experience is a responsive web app which has been designed to behave as if native to the environment it will live in.

We therefore refer to an Experience as an app in this guide.

You can load a ready-made apps from the The Store or those that have been developed specifically for you and made available in the platform.

Click here to see a working example of an app embedded using the SDK.

Using the SDK to embed Experiences is not mandatory, you can also deploy Experiences using custom code to manage loading and sizing.

Choosing Static or Dynamic Embedding

You'll need to decide which integration method you want to use.

We recommend starting with static embedding:

Embed an Experience
Fix the Experience on a specific Event
Autoresize height
Hide the header and footer of the Experience

If you need any further functionality, such as sharing data or session with the Experience or passing parameters to it, you'll need to use dynamic embedding approach.

Static Embed will soon support:

Identity & Single Sign-on
Sending and receiving messages from the Experience

First get your app metadata from Studio

In order to embed an Experience, you'll need its Project ID and Static host. This information can be retrieved from Studio by navigating to the project, then accessing the API tab within the Settings section.

There you'll find a convenient way to copy the data you need:

Last updated 5 months ago

Was this helpful?

Why Embed with the SDK?

The SDK supports the following use cases:

Launch an Experience or web app with little code

Dynamic resizing and self-managing size based on the needs of the Experience

Displaying or removing headers and footers depending on context

Preloading the Experience (native apps)

Supports sharing storage between your app and the Experience, ensuring a smooth experience for all users even in incognito windows.

You can use our demo pagebuilt with the SDK to see these features in action.

Terminology

When an app is styled, setup and offered up to the audience, we refer to it as an Experience.

For the purposes of embedding integration, an Experience is a responsive web app which has been designed to behave as if native to the environment it will live in.

We therefore refer to an Experience as an app in this guide.

You can load a ready-made apps from the The Store or those that have been developed specifically for you and made available in the platform.

Click here to see a working example of an app embedded using the SDK.

Using the SDK to embed Experiences is not mandatory, you can also deploy Experiences using custom code to manage loading and sizing.

Choosing Static or Dynamic Embedding

You'll need to decide which integration method you want to use.

We recommend starting with static embedding:

Embed an Experience

Fix the Experience on a specific Event

Autoresize height

Hide the header and footer of the Experience

If you need any further functionality, such as sharing data or session with the Experience or passing parameters to it, you'll need to use dynamic embedding approach.