How to access your Tulip Player/Instance in an iFrame

Overview

Your Tulip Instance and Tulip Player can be embedded in an iFrame on another webpage. An iFrame is an HTML element that allows you to put another webpage or link (in this case, Tulip Player/Instance) into another webpage.

How to Enable this Functionality

Navigate to Account Settings, to the “Domain Allowlist” setting.

From there, you can add any domain where you want to run Tulip Player or a Tulip Instance. In this case, we want to embed it into Tulip’s Knowledge Base.

Here’s a code snippet that would allow you to embed your Tulip Instance.

<iframe src="https://<your-instance-here>.tulip.co" width="600" height="400"></iframe>

And for your Tulip Player:

<iframe src="https://<your-instance-here>.tulip.co/player" width="600" height="400"></iframe>

Here’s what the login would look like (here’s an example of a Tulip Knowledge Base Article with a Tulip Instance login on the left and a Tulip Player login on the right).

FAQs

Are there any differences in the login/SSO experience for operators between an iFrame and a standard Tulip player/instance?

The login experience will be identical to browser player. If they are using SAML, a "Sign in with SAML" button will be shown and the operator clicks on it and it open a login popup against their iDP. Whether the login popup prompts for creds or automatically logs in the user depends on their iDP and the SAML settings.

What permissions have to be enabled for me to enable the iFrame feature?

You would either need full “account settings” permissions or would need to enable “edit player settings” on a custom user role.