+
Skip to content

feat: docs added for integrations #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: docs added for integrations #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
210 changes: 103 additions & 107 deletions docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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/"
}
}
}
"$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/"
}
}
}
25 changes: 25 additions & 0 deletions how-to-guides/integrations.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 `<head>` (or before the closing `</body>`) 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`.
点击 这是indexloc提供的php浏览器服务，不要输入任何密码和下载