Embed & Sessions

Meshes Embed lets you surface selected Meshes pages inside your own product by minting a session on your backend and mounting the returned launch_url in an iframe.

Session types

• workspace: the current full embed surface
• resource: locks the iframe to one resource + resource_id pair and supports dashboard, rules, events, and matching event detail
• dashboard: read-only dashboard-only embed

launch_page selects the initial top-level page and must be one of dashboard, connections, rules, or events.

The current public embed surface supports:

• dashboard
• connections
• rules
• events
• event detail
• connection mappings

Every integration uses two values:

• launch_url: used only for the initial iframe request
• access_token: sent after the iframe loads with meshes:auth

Start here

1. Quickstart
2. Session API Overview
3. Launch URL and Iframe Bootstrap
4. Iframe Message Contract
5. Session Roles and Scopes

Current product boundaries

• members and settings are not currently part of embed
• resource sessions cannot access connections or connection mappings
• dashboard sessions cannot access rules, events, or event detail
• OAuth-based connection setup opens a Meshes-hosted flow
• event payload viewing requires the events.payload:read scope
• a hard iframe reload should start from a fresh launch_url

Related pages

• Session Roles and Scopes
• Session Refresh Lifecycle
• Iframe Sizing and Resize Handling
• Workspace Pages Available in Embed
• OAuth and Connection Setup Behavior
• Troubleshooting