In this section
Resources / Developers
Developer Docs
Embed script reference, public URLs, roadmap Web Component, widget messaging and the client GraphQL API used by the widget.
Introduction
Embed
- Embed script referenceEvery attribute and query parameter of the Hubbo embed script, plus what happens when it boots.
- Identify visitorsTell the Hubbo embed who is logged in so Targeting can show widgets only to identified or anonymous visitors.
- Set visitor languageUse window.hubbo.setLang so the embed picks the right translation overlays for notifications, NPS, surveys and the roadmap board.
- Embed a roadmap with the Web ComponentMount a published Hubbo roadmap into any element on your page using the embed script or the hubbo-roadmap custom element.
- Public URLs: notification page, roadmap and statusThe public Hubbo pages you can link to or embed in an iframe, and how the embed=1 flag changes them.
GraphQL
- GraphQL overviewThe Hubbo GraphQL endpoint, how requests are authenticated with a project key, and what the client_* operations are.
- GraphQL: account and notificationsclient_getCurrentAccount and the client notification queries, fields and enums.
- GraphQL: NPS and surveysClient operations for NPS settings and responses (score 0 to 10) and for survey definitions and responses.
- GraphQL: roadmap, status and chatClient operations for the public roadmap, the status page and the visitor chat attached to notifications and surveys.
- Realtime subscriptions over WebSocketHow the widget receives live updates through GraphQL subscriptions, and the list of client_* subscription fields.
Behavior
- URL matching rules (whitelist and blacklist)How the widget decides whether a URL rule matches the current page: paths, full URLs, wildcards, query parameters and regular expressions.
- Widget iframe messaging (postMessage)The internal postMessage protocol between the embed shell and Hubbo-hosted iframes, and what is safe to rely on.
- usageAllowed and the page-view gateHow page views are counted, how the gate returns usageAllowed false, and what the embed does when the plan limit is reached.