diff --git a/docs.json b/docs.json index 7015ec3..376fc5b 100644 --- a/docs.json +++ b/docs.json @@ -1,108 +1,104 @@ { - "$schema": "https://mintlify.com/docs.json", - "theme": "mint", - "name": "Usertour documention", - "colors": { - "primary": "#0D9373", - "light": "#07C983", - "dark": "#0D9373" - }, - "favicon": "/images/favicon.png", - "navigation": { - "anchors": [ - { - "anchor": "Documentation", - "icon": "book-open", - "groups": [ - { - "group": "Get Started", - "pages": [ - "why-usertour", - "quickstart", - "faq" - ] - }, - { - "group": "How-to Guides", - "pages": [ - "building-experiences/understanding-the-basics-of-in-app-flows", - "building-experiences/creating-your-first-flow", - "how-to-guides/starting-flows", - "how-to-guides/checklists", - "how-to-guides/launchers", - "how-to-guides/environments", - "how-to-guides/users-and-segments", - "how-to-guides/companies", - "how-to-guides/urls", - "how-to-guides/flow-analytics" - ] - }, - { - "group": "Developers", - "pages": [ - "developers/csp", - { - "group": "Usertourjs Reference", - "icon": "connectdevelop", - "pages": [ - "developers/usertourjs-reference/overview", - "developers/usertourjs-reference/installation", - "developers/usertourjs-reference/method" - ] - } - ] - }, - { - "group": "Open Source", - "pages": [ - "open-source/env", - "open-source/self-hosting", - "open-source/usertourjs", - "open-source/local-development" - - ] - } - ] - } - ], - "global": { - "anchors": [ - { - "anchor": "Community", - "href": "https://discord.gg/WPVJPX8fJh", - "icon": "discord" - }, - { - "anchor": "Github", - "href": "https://github.com/usertour/usertour", - "icon": "github" - }, - { - "anchor": "Usertour", - "href": "https://www.usertour.io/", - "icon": "arrow-up-right-from-square" - } - ] - } - }, - "logo": { - "light": "/logo-dark.svg", - "dark": "/logo-light.svg", - "href": "https://www.usertour.io/" - }, - "navbar": { - "links": [ - { - "label": "Support", - "href": "mailto:support@usertour.io" - } - ] - }, - "footer": { - "socials": { - "x": "https://x.com/usertourio", - "github": "https://github.com/usertour/usertour", - "linkedin": "https://www.linkedin.com/company/usertour/" - } - } -} \ No newline at end of file + "$schema": "https://mintlify.com/docs.json", + "theme": "mint", + "name": "Usertour documention", + "colors": { + "primary": "#0D9373", + "light": "#07C983", + "dark": "#0D9373" + }, + "favicon": "/images/favicon.png", + "navigation": { + "anchors": [ + { + "anchor": "Documentation", + "icon": "book-open", + "groups": [ + { + "group": "Get Started", + "pages": ["why-usertour", "quickstart", "faq"] + }, + { + "group": "How-to Guides", + "pages": [ + "building-experiences/understanding-the-basics-of-in-app-flows", + "building-experiences/creating-your-first-flow", + "how-to-guides/starting-flows", + "how-to-guides/checklists", + "how-to-guides/launchers", + "how-to-guides/environments", + "how-to-guides/users-and-segments", + "how-to-guides/companies", + "how-to-guides/urls", + "how-to-guides/flow-analytics", + "how-to-guides/integrations" + ] + }, + { + "group": "Developers", + "pages": [ + "developers/csp", + { + "group": "Usertourjs Reference", + "icon": "connectdevelop", + "pages": [ + "developers/usertourjs-reference/overview", + "developers/usertourjs-reference/installation", + "developers/usertourjs-reference/method" + ] + } + ] + }, + { + "group": "Open Source", + "pages": [ + "open-source/env", + "open-source/self-hosting", + "open-source/usertourjs", + "open-source/local-development" + ] + } + ] + } + ], + "global": { + "anchors": [ + { + "anchor": "Community", + "href": "https://discord.gg/WPVJPX8fJh", + "icon": "discord" + }, + { + "anchor": "Github", + "href": "https://github.com/usertour/usertour", + "icon": "github" + }, + { + "anchor": "Usertour", + "href": "https://www.usertour.io/", + "icon": "arrow-up-right-from-square" + } + ] + } + }, + "logo": { + "light": "/logo-dark.svg", + "dark": "/logo-light.svg", + "href": "https://www.usertour.io/" + }, + "navbar": { + "links": [ + { + "label": "Support", + "href": "mailto:support@usertour.io" + } + ] + }, + "footer": { + "socials": { + "x": "https://x.com/usertourio", + "github": "https://github.com/usertour/usertour", + "linkedin": "https://www.linkedin.com/company/usertour/" + } + } +} diff --git a/how-to-guides/integrations.mdx b/how-to-guides/integrations.mdx new file mode 100644 index 0000000..50cb0a3 --- /dev/null +++ b/how-to-guides/integrations.mdx @@ -0,0 +1,25 @@ +--- +title: Integrations +slug: /integrations +description: Learn how to integrate UserTour.js with popular analytics platforms. +icon: "puzzle-piece" +--- + +## Summary + +UserTour.js supports forwarding events to popular analytics platforms via their JavaScript SDKs. To use these integrations, your client must include each provider’s SDK snippet and initialize it correctly in the `` (or before the closing ``) of your application. Once loaded, UserTour.js will detect the global objects (e.g. `gtag`, `amplitude`, `mixpanel`) and dispatch events automatically. + +## Available Integrations + +Currently supported integrations rely on client-side SDKs: +- **Google Analytics (gtag.js)** +- **Amplitude Browser SDK** +- **HubSpot JavaScript API** +- **Intercom JavaScript API** +- **Klaviyo JavaScript SDK** +- **LogRocket Web SDK** +- **Mixpanel JavaScript SDK** +- **PostHog JavaScript SDK** +- **Segment Analytics.js** + +> _Note:_ These integrations depend on the provider’s global objects being available on `window`.