What is Ridge?
Ridge AI builds dashboards from your data. Embedding puts a published dashboard inside your product while Ridge continues to serve its specification and data.
The Ridge Embed SDK has two integration surfaces:
- An iframe embed loads a signed Ridge URL in its own document. It is the shortest path to production and can be controlled through
postMessagewhen needed. - An inline embed mounts directly into your page. Your server mints a short-lived JWT, and your browser receives a richer JavaScript handle for state, events, theming, and export.
They render the same dashboard and share the same state model, but their credentials, isolation, lifecycle, and JavaScript APIs are different. Start with Choose an embed rather than treating them as interchangeable.
The guides
- Choose an embed — compare the two integration surfaces.
- Iframe quickstart — embed a signed URL with no host JavaScript.
- Inline quickstart — exchange an API key for a JWT and mount inline.
- Authentication — separately documented for iframe and inline embeds.
- Dashboard state — read and write component state; discover what each accepts.
- Filters — the one state key that filterable components share.
- Partitioning — enforce row-level data access.
- Events — react to user interaction and know when a render has settled.
- Theming — match the dashboard to your product's design.
- Reference — the generated API surface.