get https://api.lucid.co/embeds
Display an embed within an <iframe>.
- If no embed id was included when creating the token, the
<iframe>first displays a document picker where the user can create and configure a new embed. - If embed id was included, then, depending on the embed session token request body and embed settings, the
<iframe>displays either an embedded document viewer, an embedded editor where users can collaborate, or an embed configuration page for the associated document.
<iframe
src='https://lucid.app/embeds?token=:token'
></iframe>
Document Embedding Event
Below is a list of possible events via postMessage sent to the parent window:
The EmbedCreated event
Fired when a new embed is created by the user.
| Property | Type | Description |
|---|---|---|
| type | String | "LucidEmbedEvent" |
| event | String | "EmbedCreated" |
| documentId | UUID | ID of the selected document. |
| embedId | String | ID of the newly created document embed. |
| signature | String | Signature of the newly created document embed. |
The SettingsClosed event
Fired when the embed settings are updated by the user.
| Property | Type | Description |
|---|---|---|
| type | String | "LucidEmbedEvent" |
| event | String | "SettingsClosed" |
| settingsUpdated | Boolean | true if the user changed the embed settings. |
The OpenCustomSettings event
Fired when the "Settings for " button is clicked by the user.
| Property | Type | Description |
|---|---|---|
| type | String | "LucidEmbedEvent" |
| event | String | "OpenCustomSettings" |
Responses
Unauthorized. The token is missing or invalid.
Forbidden. The access to the embed is forbidden.
Not Found. The embed id is not found.