{ "$schema": "https://mintlify.com/docs.json", "name": "Hexclave Documentation", "theme": "mint", "logo": { "dark": "/images/logo-dark.svg", "light": "/images/logo-light.svg" }, "favicon": "/images/favicon.ico", "colors": { "primary": "#6b5df7", "light": "#8b7cf9", "dark": "#6b5df7" }, "background": { "color": { "dark": "#09090b" } }, "contextual": { "options": [ "copy", "view", "assistant", "chatgpt", "claude", "perplexity", "grok", "aistudio", "devin", "windsurf", "mcp", "cursor", "vscode", "devin-mcp" ] }, "fonts": { "heading": { "family": "Geist", "weight": 500 }, "body": { "family": "Geist", "weight": 400 } }, "navbar": { "links": [ { "type": "github", "href": "https://github.com/hexclave/hexclave" } ], "primary": { "type": "button", "label": "Dashboard", "href": "https://app.hexclave.com" } }, "navigation": { "tabs": [ { "tab": "Documentation", "pages": [ "index", { "group": "Getting Started", "pages": [ "guides/getting-started/setup", "guides/getting-started/user-fundamentals", "guides/getting-started/ai-integration" ] }, { "group": "Going Further", "pages": [ "guides/going-further/stack-app", "guides/going-further/backend-integration", "guides/going-further/cli", "guides/going-further/user-metadata" ] }, { "group": "Apps", "pages": [ { "group": "Authentication", "icon": "/images/app-icons/authentication.svg", "pages": [ "guides/apps/authentication/overview", "guides/apps/authentication/user-onboarding", "guides/apps/authentication/restricted-users", "guides/apps/authentication/connected-accounts", "guides/apps/authentication/jwts", "guides/apps/authentication/sign-up-rules", "guides/apps/authentication/cli-authentication", "guides/apps/authentication/fraud-protection", { "group": "All Auth Providers", "root": "guides/apps/authentication/auth-providers", "pages": [ "guides/apps/authentication/auth-providers/apple", "guides/apps/authentication/auth-providers/bitbucket", "guides/apps/authentication/auth-providers/discord", "guides/apps/authentication/auth-providers/facebook", "guides/apps/authentication/auth-providers/github", "guides/apps/authentication/auth-providers/gitlab", "guides/apps/authentication/auth-providers/google", "guides/apps/authentication/auth-providers/linkedin", "guides/apps/authentication/auth-providers/microsoft", "guides/apps/authentication/auth-providers/passkey", "guides/apps/authentication/auth-providers/spotify", "guides/apps/authentication/auth-providers/twitch", "guides/apps/authentication/auth-providers/two-factor-auth", "guides/apps/authentication/auth-providers/x-twitter" ] } ] }, { "group": "Emails", "icon": "/images/app-icons/emails.svg", "pages": [ "guides/apps/emails/overview" ] }, { "group": "Payments", "icon": "/images/app-icons/payments.svg", "pages": [ "guides/apps/payments/overview" ] }, { "group": "Analytics", "icon": "/images/app-icons/analytics.svg", "pages": [ "guides/apps/analytics/overview" ] }, { "group": "Teams", "icon": "/images/app-icons/teams.svg", "pages": [ "guides/apps/teams/overview", "guides/apps/teams/team-selection" ] }, "guides/apps/rbac/overview", "guides/apps/api-keys/overview", "guides/apps/data-vault/overview", "guides/apps/webhooks/overview", "guides/apps/launch-checklist/overview" ] }, { "group": "Dashboard reference", "hidden": true, "searchable": true, "pages": [ { "group": "Analytics", "icon": "/images/app-icons/analytics.svg", "pages": [ "guides/dashboard-references/analytics/tables", "guides/dashboard-references/analytics/replays", "guides/dashboard-references/analytics/queries" ] }, { "group": "API Keys", "icon": "/images/app-icons/api-keys.svg", "pages": [ "guides/dashboard-references/api-keys/api-keys" ] }, { "group": "Authentication", "icon": "/images/app-icons/authentication.svg", "pages": [ "guides/dashboard-references/authentication/auth-methods", "guides/dashboard-references/authentication/sign-up-rules" ] }, { "group": "Catalyst", "icon": "/images/app-icons/catalyst.svg", "pages": [ "guides/dashboard-references/catalyst/catalyst" ] }, { "group": "Convex Integration", "icon": "/images/app-icons/convex.svg", "pages": [ "guides/dashboard-references/convex/convex-integration" ] }, { "group": "Data Vault", "icon": "/images/app-icons/data-vault.svg", "pages": [ "guides/dashboard-references/data-vault/data-vault" ] }, { "group": "Email API", "icon": "/images/app-icons/email-api.svg", "pages": [ "guides/dashboard-references/email-api/email-api" ] }, { "group": "Emails", "icon": "/images/app-icons/emails.svg", "pages": [ "guides/dashboard-references/emails/sent", "guides/dashboard-references/emails/drafts", "guides/dashboard-references/emails/templates", "guides/dashboard-references/emails/email-settings" ] }, { "group": "Launch Checklist", "icon": "/images/app-icons/launch-checklist.svg", "pages": [ "guides/dashboard-references/launch-checklist/launch-checklist" ] }, { "group": "Neon Integration", "icon": "/images/app-icons/neon.svg", "pages": [ "guides/dashboard-references/neon/neon-integration" ] }, { "group": "Onboarding", "icon": "/images/app-icons/onboarding.svg", "pages": [ "guides/dashboard-references/onboarding/onboarding" ] }, { "group": "Payments", "icon": "/images/app-icons/payments.svg", "pages": [ "guides/dashboard-references/payments/product-lines", "guides/dashboard-references/payments/products-and-items", "guides/dashboard-references/payments/customers", "guides/dashboard-references/payments/transactions", "guides/dashboard-references/payments/payouts", "guides/dashboard-references/payments/settings" ] }, { "group": "RBAC", "icon": "/images/app-icons/rbac.svg", "pages": [ "guides/dashboard-references/rbac/project-permissions", "guides/dashboard-references/rbac/team-permissions" ] }, { "group": "Support", "icon": "/images/app-icons/support.svg", "pages": [ "guides/dashboard-references/support/conversations" ] }, { "group": "Teams", "icon": "/images/app-icons/teams.svg", "pages": [ "guides/dashboard-references/teams/teams", "guides/dashboard-references/teams/team-settings" ] }, { "group": "TV mode", "icon": "/images/app-icons/tv-mode.svg", "pages": [ "guides/dashboard-references/tv-mode/tv-mode" ] }, { "group": "Vercel Integration", "icon": "/images/app-icons/vercel.svg", "pages": [ "guides/dashboard-references/vercel/setup" ] }, { "group": "Webhooks", "icon": "/images/app-icons/webhooks.svg", "pages": [ "guides/dashboard-references/webhooks/webhooks" ] } ] }, { "group": "Integrations", "pages": [ "guides/integrations/tanstack-start/overview", "guides/integrations/supabase/overview", "guides/integrations/convex/overview", "guides/integrations/vercel/overview" ] }, { "group": "Other", "pages": [ "guides/other/self-host", "guides/other/known-errors", "migration", { "group": "Tutorials", "pages": [ "guides/other/tutorials/build-a-saas-with-hexclave", "guides/other/tutorials/build-a-team-based-app", "guides/other/tutorials/ship-production-ready-auth" ] } ] } ] }, { "tab": "SDK Reference", "pages": [ "sdk/overview", { "group": "Objects", "pages": [ "sdk/objects/stack-app" ] }, { "group": "Types", "pages": [ "sdk/types/user", "sdk/types/team", "sdk/types/team-user", "sdk/types/team-permission", "sdk/types/team-profile", "sdk/types/contact-channel", "sdk/types/email", "sdk/types/api-key", "sdk/types/project", "sdk/types/connected-account", "sdk/types/item", "sdk/types/customer" ] }, { "group": "Hooks", "pages": [ "sdk/hooks/use-stack-app", "sdk/hooks/use-user" ] } ] }, { "tab": "REST API", "pages": [ "api/overview", { "group": "Client API", "openapi": { "source": "openapi/client.json", "directory": "api/client" } }, { "group": "Server API", "openapi": { "source": "openapi/server.json", "directory": "api/server" } }, { "group": "Admin API", "openapi": { "source": "openapi/admin.json", "directory": "api/admin", "hidden": "true" } }, { "group": "Webhooks", "openapi": { "source": "openapi/webhooks.json", "directory": "api/webhooks" } } ] } ] }, "footer": { "socials": { "x": "https://x.com/stack_auth", "github": "https://github.com/hexclave/hexclave", "discord": "https://discord.hexclave.com" } }, "seo": { "metatags": { "robots": "noindex" } }, "settings": { "customScripts": [ "/apps-sidebar-filter.js", "/code-language-labels.js" ] }, "redirects": [ { "source": "/guides/apps/fraud-protection/overview", "destination": "/guides/apps/authentication/fraud-protection" }, { "source": "/rest-api/overview", "destination": "/api/overview" }, { "source": "/getting-started/setup", "destination": "/guides/getting-started/setup" }, { "source": "/docs/getting-started/setup", "destination": "/guides/getting-started/setup" }, { "source": "/docs/next/getting-started/setup", "destination": "/guides/getting-started/setup" }, { "source": "/docs/sdk", "destination": "/sdk/overview" }, { "source": "/docs/apps/analytics", "destination": "/guides/apps/analytics/overview" }, { "source": "/docs/apps/api-keys", "destination": "/guides/apps/api-keys/overview" }, { "source": "/docs/others/convex", "destination": "/guides/integrations/convex/overview" }, { "source": "/docs/concepts/teams", "destination": "/guides/apps/teams/overview" }, { "source": "/docs/concepts/custom-user-data", "destination": "/guides/going-further/user-metadata" }, { "source": "/others/js-client", "destination": "/guides/going-further/stack-app" }, { "source": "/guides/apps/emails/sent", "destination": "/guides/dashboard-references/emails/sent" }, { "source": "/guides/apps/emails/drafts", "destination": "/guides/dashboard-references/emails/drafts" }, { "source": "/guides/apps/emails/templates", "destination": "/guides/dashboard-references/emails/templates" }, { "source": "/guides/apps/emails/email-settings", "destination": "/guides/dashboard-references/emails/email-settings" }, { "source": "/guides/apps/analytics/tables", "destination": "/guides/dashboard-references/analytics/tables" }, { "source": "/guides/apps/analytics/queries", "destination": "/guides/dashboard-references/analytics/queries" }, { "source": "/guides/apps/analytics/replays", "destination": "/guides/dashboard-references/analytics/replays" }, { "source": "/guides/apps/payments/product-lines", "destination": "/guides/dashboard-references/payments/product-lines" }, { "source": "/guides/apps/payments/products-and-items", "destination": "/guides/dashboard-references/payments/products-and-items" }, { "source": "/guides/apps/payments/customers", "destination": "/guides/dashboard-references/payments/customers" }, { "source": "/guides/apps/payments/transactions", "destination": "/guides/dashboard-references/payments/transactions" }, { "source": "/guides/apps/payments/settings", "destination": "/guides/dashboard-references/payments/settings" }, { "source": "/guides/apps/authentication/auth-methods", "destination": "/guides/dashboard-references/authentication/auth-methods" }, { "source": "/guides/apps/authentication/sign-up-rules", "destination": "/guides/dashboard-references/authentication/sign-up-rules" }, { "source": "/guides/apps/catalyst/catalyst", "destination": "/guides/dashboard-references/catalyst/catalyst" }, { "source": "/guides/apps/convex/convex-integration", "destination": "/guides/dashboard-references/convex/convex-integration" }, { "source": "/guides/apps/neon/neon-integration", "destination": "/guides/dashboard-references/neon/neon-integration" }, { "source": "/guides/apps/onboarding/onboarding", "destination": "/guides/dashboard-references/onboarding/onboarding" }, { "source": "/guides/apps/rbac/project-permissions", "destination": "/guides/dashboard-references/rbac/project-permissions" }, { "source": "/guides/apps/rbac/team-permissions", "destination": "/guides/dashboard-references/rbac/team-permissions" }, { "source": "/guides/apps/support/conversations", "destination": "/guides/dashboard-references/support/conversations" }, { "source": "/guides/apps/teams/teams", "destination": "/guides/dashboard-references/teams/teams" }, { "source": "/guides/apps/teams/team-settings", "destination": "/guides/dashboard-references/teams/team-settings" }, { "source": "/guides/apps/vercel/setup", "destination": "/guides/dashboard-references/vercel/setup" }, { "source": "/guides/apps/webhooks/webhooks", "destination": "/guides/dashboard-references/webhooks/webhooks" }, { "source": "/guides/apps/api-keys/api-keys", "destination": "/guides/dashboard-references/api-keys/api-keys" }, { "source": "/guides/apps/data-vault/data-vault", "destination": "/guides/dashboard-references/data-vault/data-vault" }, { "source": "/guides/apps/email-api/email-api", "destination": "/guides/dashboard-references/email-api/email-api" }, { "source": "/guides/apps/launch-checklist/launch-checklist", "destination": "/guides/dashboard-references/launch-checklist/launch-checklist" }, { "source": "/guides/apps/tv-mode/tv-mode", "destination": "/guides/dashboard-references/tv-mode/tv-mode" }, { "source": "/guides/apps/payments/payouts", "destination": "/guides/dashboard-references/payments/payouts" } ] }