For the complete documentation index, see llms.txt. This page is also available as Markdown.

Authenticated embeds

Embed private Felt maps in your site or app. Use REST API embed tokens or restrict access to people invited to the map.

Embed a private Felt map on your website, portal, or application with either embed tokens or Felt invitations. For a map anyone can open, use a public embed.

Detail
Embed token
Invited people

Who can see the map

Anyone your server gives a token to

People logged in to Felt with access to the map

Felt account needed

No

Yes, a free account is enough

How long access lasts

12 hours per token

Until you remove their access

Setup

Code on your server that calls the REST API

The map's share settings

Plan

Platform add-on

Team plan and up

Embed a map with a token

An embed token lets one visitor view a private embedded map without having a Felt account or joining your workspace. Your server creates the token with the REST API, using an API token that can view the map. The Platform add-on includes this API access.

  1. In Felt, open the map in edit mode. In the toolbar, click Developer Platform > Copy map ID.

  2. On your server, call the REST API's create embed token endpoint with the map ID and the visitor's email address. Felt uses the email address for tracking.

  3. On the visitor's page, add the token to the embed URL as the token query parameter, for example https://felt.com/embed/map/{mapId}?token={token}.

The embed tokens reference has the request and response.

An embed token gives view access to one map for 12 hours. When it expires, the embed asks the visitor to refresh, so get a new token on every page load. Visitors with a token can't edit or comment, and each load of the map counts as a map view. See Plan usage.

Visitors with a token can export the map's data only if the map's Export data setting is on. See Map settings.

Embed a map for invited people

An embed for invited people shows the map only to people who are logged in to Felt and have access to it.

  1. On the map, click Share at the top right.

  2. Click the Public access selector and select None.

  3. In Emails, enter the email address of each person who should see the map. Each address must match the one on that person's Felt account.

  4. Click Invite.

  5. Copy the embed code and add it to your site. See Embed a map.

People you invite need a free Felt account, and people without a seat count as viewers. See Seats and viewers.

Last updated

Was this helpful?