Embed API FAQs

For an introduction to Lucid's Embed APIs, please see here.

How do I decide what kind of Lucid embed to use?

We recommend using cookie-based embeds for most use cases, because the API is significantly easier to use. However, if you want users to be able to view embedded documents even if they don't have access in Lucid (or don't have a Lucid account), then you'll want to use token-based embeds instead.

The token-based embedded experience requires your integration to manage the granting and storage of OAuth 2.0 tokens securely. Cookie-based embeds do not require any token management.

What happens if a user tries to view a cookie-based embed but doesn't have access?

The iframe will display a "request access" or "log in" message, as appropriate. This is because the embed utilizes browser cookies to authorize displaying the embedded document in your webpage.

If the cookie embed was created using a share link, then the user will be able to access the document according to the settings on the share link (as if they had accessed the share link directly).

How do Lucid embeds handle updates to the original document in Lucid?

Lucid embeds always update when changes are made to the original document, with one exception: token-based embeds can be configured by the user to not automatically update, in which case they display a snapshot of the document at the time the embed was created.

Do Lucid embeds require third-party cookies?

The document picker (part of the token-based solution) and cookie-based solution both require access to Lucid session cookies, which are considered "third-party" when embedded in a non-Lucid site. To solve this, the embed APIs use the browser's Storage Access API to request cookie access as needed.

Can a user embed Lucidspark "breakout boards"?

Currently, breakout boards can't be selected in the document picker, so cookie embeds are the only way to embed these boards.

(This might change in the future as we improve our API. If this feature would be valuable for your specific needs, please let us know in our developer community! We appreciate your feedback. ♥️)