/
githubmirror
/
novu
Обзор
Документация
Войти
/
githubmirror
/
novu
Код
Запросы
0
Пакеты
0
Релизы
0
Аналитика
Безопасность
v3.19.0
docs/docs.json
1 763 строки
62 KB
Pawan Jain
feat(docs): add missing email and SMS integration documentation fixes DOC-427 (#12257)
07 авг 2026, 08:16
Не верифицирован
07 авг 2026, 08:16
a8f316a
Код
Авторство
О чём код?
{ "$schema": "https://mintlify.com/docs.json", "theme": "luma", "name": "Novu", "description": "The open-source notification infrastructure for agents and products. Send, receive, and track notifications across channels.", "colors": { "primary": "#0e121b", "light": "#FFFFFF", "dark": "#FFFFFF" }, "background": {}, "favicon": "/favicon.svg", "icons": { "library": "lucide" }, "logo": { "light": "/logo/light.svg", "dark": "/logo/dark.svg", "href": "https://docs.novu.co" }, "seo": { "indexing": "all", "metatags": { "og:type": "website", "twitter:card": "summary_large_image" } }, "thumbnails": { "appearance": "dark", "background": "/images/og/og-image-docs-v2.jpg", "fonts": { "family": "Inter" } }, "interaction": { "drilldown": true }, "navigation": { "global": { "anchors": [] }, "tabs": [ { "tab": "Notify", "groups": [ { "group": "Getting Started", "boost": 3, "pages": [ "platform", "platform/what-is-novu", "platform/how-novu-works", { "group": "Novu for your team", "pages": ["platform/novu-for/developers", "platform/novu-for/product"] }, { "group": "Core Concepts", "pages": [ "platform/concepts/notification-event", "platform/concepts/workflows", "platform/concepts/subscribers", "platform/concepts/topics", "platform/concepts/integrations", "platform/concepts/trigger", "platform/concepts/preferences", "platform/concepts/contexts", "platform/concepts/tenants" ] }, { "group": "Quickstart", "pages": [ "platform/quickstart/nextjs", "platform/quickstart/react", "platform/quickstart/remix", "platform/quickstart/angular", "platform/quickstart/vue", "platform/quickstart/nuxt", "platform/quickstart/vanilla-js" ] } ] }, { "group": "Integrate <Inbox />", "pages": [ "platform/inbox", "platform/inbox/setup-inbox", { "group": "Features", "pages": ["platform/inbox/features/snooze", "platform/inbox/features/schedule"] }, { "group": "Customize and Configure", "pages": [ "platform/inbox/configuration/styling", "platform/inbox/configuration/tabs", "platform/inbox/configuration/preferences", "platform/inbox/configuration/data-object", "platform/inbox/configuration/inbox-with-context", "platform/inbox/configuration/icons" ] }, { "group": "Advanced Customization", "pages": [ "platform/inbox/advanced-customization/customize-bell", "platform/inbox/advanced-customization/customize-popover", "platform/inbox/advanced-customization/customize-notification-items", "platform/inbox/advanced-customization/conditional-display", "platform/inbox/advanced-customization/html-in-notifications", "platform/inbox/advanced-customization/notification-click-behavior" ] }, { "group": "Advanced Features", "pages": [ "platform/inbox/advanced-features/localization", "platform/inbox/advanced-features/multi-tenancy" ] }, "platform/inbox/headless-mode", "platform/inbox/prepare-for-production", "platform/inbox/migration-guide" ], "icon": "inbox" }, { "group": "Integrate <Subscription />", "pages": [ "platform/subscription", "platform/subscription/quickstart", "platform/subscription/manage-topic-subscriptions", "platform/subscription/customize-and-configure", "platform/subscription/headless-hooks" ], "icon": "bell-ring" }, { "group": "Build a Workflow", "pages": [ "platform/workflow", "platform/workflow/create-a-workflow", "platform/workflow/configure-workflow", { "group": "Add And Configure Steps", "root": "platform/workflow/add-and-configure-steps", "pages": [ { "group": "Configure Action Steps", "pages": [ "platform/workflow/add-and-configure-steps/configure-action-steps/delay", "platform/workflow/add-and-configure-steps/configure-action-steps/digest", "platform/workflow/add-and-configure-steps/configure-action-steps/throttle", "platform/workflow/add-and-configure-steps/configure-action-steps/http-step" ] }, "platform/workflow/add-and-configure-steps/step-conditions", "platform/workflow/add-and-configure-steps/code-steps" ] }, { "group": "Add Notification Content", "pages": [ "platform/workflow/add-notification-content/channels-template-editors", "platform/workflow/add-notification-content/personalize-content" ] }, "platform/workflow/trigger-workflow", "platform/workflow/monitor-and-debug-workflow", { "group": "Advanced Features", "pages": [ "platform/workflow/advanced-features/translations", { "group": "Contexts", "pages": [ "platform/workflow/advanced-features/contexts/manage-contexts", "platform/workflow/advanced-features/contexts/contexts-in-workflows" ] } ] } ], "icon": "git-branch" }, { "group": "Integrate Channels Providers", "pages": [ "platform/integrations", "platform/integrations/demo-integration", { "group": "Chat", "root": "platform/integrations/chat", "pages": [ "platform/integrations/chat/discord", "platform/integrations/chat/line", "platform/integrations/chat/mattermost", "platform/integrations/chat/ms-teams", "platform/integrations/chat/slack", "platform/integrations/chat/webex-messaging", "platform/integrations/chat/telegram", "platform/integrations/chat/whats-app", "platform/integrations/chat/zulip" ] }, { "group": "Email", "root": "platform/integrations/email", "pages": [ "platform/integrations/email/sendgrid", "platform/integrations/email/amazon-ses", "platform/integrations/email/resend", "platform/integrations/email/postmark", "platform/integrations/email/brevo", "platform/integrations/email/mailgun", "platform/integrations/email/mailjet", "platform/integrations/email/sparkpost", "platform/integrations/email/mandrill", "platform/integrations/email/outlook365", "platform/integrations/email/infobip", "platform/integrations/email/braze", "platform/integrations/email/mailersend", "platform/integrations/email/mailtrap", "platform/integrations/email/netcore", "platform/integrations/email/plunk", "platform/integrations/email/anypost", "platform/integrations/email/webhook", "platform/integrations/email/custom-smtp", "platform/integrations/email/writing-email-template", { "group": "Activity Tracking", "pages": [ { "group": "Manual Configuration", "pages": [ "platform/integrations/email/activity-tracking/manual-configuration/ses", "platform/integrations/email/activity-tracking/manual-configuration/mailgun", "platform/integrations/email/activity-tracking/manual-configuration/resend", "platform/integrations/email/activity-tracking/manual-configuration/sendgrid", "platform/integrations/email/activity-tracking/manual-configuration/anypost" ] } ] } ] }, { "group": "Push", "root": "platform/integrations/push", "pages": [ "platform/integrations/push/fcm", "platform/integrations/push/expo-push", "platform/integrations/push/apns", "platform/integrations/push/onesignal", "platform/integrations/push/push-webhook", "platform/integrations/push/pusher-beams", "platform/integrations/push/pushpad", "platform/integrations/push/push-activity-tracking" ] }, { "group": "Sms", "root": "platform/integrations/sms", "pages": [ "platform/integrations/sms/twilio", "platform/integrations/sms/aws-sns", "platform/integrations/sms/infobip", "platform/integrations/sms/sinch", "platform/integrations/sms/nexmo", "platform/integrations/sms/messagebird", "platform/integrations/sms/telnyx", "platform/integrations/sms/cm-com", "platform/integrations/sms/plivo", "platform/integrations/sms/bandwidth", "platform/integrations/sms/ring-central", "platform/integrations/sms/azure", "platform/integrations/sms/clicksend", "platform/integrations/sms/brevo", "platform/integrations/sms/clickatell", "platform/integrations/sms/bulk-sms", "platform/integrations/sms/sms77", "platform/integrations/sms/africas-talking", "platform/integrations/sms/unifonic", "platform/integrations/sms/gupshup", "platform/integrations/sms/termii", "platform/integrations/sms/kudosity", "platform/integrations/sms/sendchamp", "platform/integrations/sms/simpletexting", "platform/integrations/sms/46elks", "platform/integrations/sms/firetext", "platform/integrations/sms/sms-central", "platform/integrations/sms/kannel", "platform/integrations/sms/maqsam", "platform/integrations/sms/mobishastra", "platform/integrations/sms/afro-message", "platform/integrations/sms/smsmode", "platform/integrations/sms/isend-sms", "platform/integrations/sms/isendpro", "platform/integrations/sms/imedia", "platform/integrations/sms/eazy", "platform/integrations/sms/ruach-sms", "platform/integrations/sms/sms-webhook" ] }, { "group": "Tool", "pages": [ "platform/integrations/tool/pagerduty", "platform/integrations/tool/opsgenie", "platform/integrations/tool/grafana", "platform/integrations/tool/webhook" ] }, "platform/integrations/trigger-overrides" ], "icon": "plug-zap" }, { "group": "SDKs", "pages": [ "platform/sdks", { "group": "@novu/react", "pages": [ "platform/sdks/react", { "group": "Hooks", "pages": [ "platform/sdks/react/hooks/novu-provider", "platform/sdks/react/hooks/subscription", "platform/sdks/react/hooks/use-counts", "platform/sdks/react/hooks/use-notifications", "platform/sdks/react/hooks/use-novu", "platform/sdks/react/hooks/use-preferences", "platform/sdks/react/hooks/use-schedule" ] }, "platform/sdks/react/changelog" ] }, "platform/sdks/javascript", { "group": "@novu/react-native", "root": "platform/sdks/react-native", "pages": [ "platform/sdks/react-native", { "group": "Hooks", "pages": [ "platform/sdks/react-native/hooks/novu-provider", "platform/sdks/react-native/hooks/use-novu", "platform/sdks/react-native/hooks/use-notifications", "platform/sdks/react-native/hooks/use-counts", "platform/sdks/react-native/hooks/use-preferences", "platform/sdks/react-native/hooks/use-schedule" ] } ] }, { "group": "Server-Side", "root": "platform/sdks/server", "pages": [ "platform/sdks/server/typescript", "platform/sdks/server/python", "platform/sdks/server/go", "platform/sdks/server/php", "platform/sdks/server/dotnet", "platform/sdks/server/java", "platform/sdks/server/kotlin", "platform/sdks/server/laravel", "platform/sdks/server/ruby" ] } ], "icon": "code" }, { "group": "Developer", "pages": [ "platform/developer/api-keys", "platform/developer/environments", "platform/developer/environment-variables", "platform/developer/limits", { "group": "Inbound email", "pages": ["platform/inbound-email/overview"] }, { "group": "Webhooks", "pages": [ "platform/developer/webhooks/webhooks", "platform/developer/webhooks/event-types", "platform/developer/webhooks/connectors" ] } ], "icon": "terminal" }, { "group": "Account", "pages": [ "platform/account/authentication", "platform/account/organizations", "platform/account/roles-and-permissions", "platform/account/manage-members", "platform/account/billing", "platform/account/sso" ], "icon": "building-2" }, { "group": "Build with AI", "pages": [ "platform/build-with-ai/mcp", "platform/build-with-ai/skills", "platform/build-with-ai/agent-toolkit" ], "icon": "sparkles" }, { "group": "Additional Resources", "pages": [ "platform/additional-resources/glossary", "platform/additional-resources/errors", "platform/additional-resources/security", "platform/additional-resources/legacy-documentation" ], "icon": "book-open" } ] }, { "tab": "Agent Connect", "groups": [ { "group": "Getting Started", "boost": 3, "pages": [ "agents", "agents/get-started/what-is-aci", "agents/get-started/mental-model", "agents/get-started/agents-and-providers", { "group": "Quickstart", "pages": [ "agents/get-started/ai-sdk", "agents/get-started/langchain", "agents/get-started/mastra", "agents/get-started/claude-managed", "agents/get-started/aws-claude" ] } ] }, { "group": "Channels", "pages": [ "agents/channels/overview", "agents/channels/slack", "agents/channels/microsoft-teams", "agents/channels/whatsapp", "agents/channels/telegram", "agents/channels/email" ], "icon": "messages-square" }, { "group": "Custom Code Agent", "pages": [ "agents/custom-code-agent/concepts", "agents/custom-code-agent/connecting-your-app", { "group": "Frameworks", "pages": [ "agents/custom-code-agent/frameworks/ai-sdk", "agents/custom-code-agent/frameworks/langchain", "agents/custom-code-agent/frameworks/other" ] }, { "group": "Building blocks", "pages": [ "agents/custom-code-agent/building-blocks/handle-events", "agents/custom-code-agent/building-blocks/reply", "agents/custom-code-agent/building-blocks/typing-indicator", "agents/custom-code-agent/building-blocks/edit-sent-messages", "agents/custom-code-agent/building-blocks/signals", "agents/custom-code-agent/building-blocks/tool-approval" ] }, "agents/custom-code-agent/connect-components", "agents/custom-code-agent/going-to-production" ], "icon": "code" }, { "group": "Managed Agent", "pages": [ "agents/managed-agent/overview", "agents/managed-agent/concepts", "agents/managed-agent/configure-mcp-servers", "agents/managed-agent/add-skills" ], "icon": "bot" }, { "group": "Observability", "pages": ["agents/conversations"], "icon": "eye" } ] }, { "tab": "API Reference", "groups": [ { "group": "Getting Started", "pages": [ "api-reference", "api-reference/authentication", "api-reference/errors", "api-reference/pagination", "api-reference/rate-limiting", "api-reference/idempotency", "api-reference/payload-limits" ] }, { "group": "Notification delivery", "icon": "send", "pages": [ { "group": "Events", "expanded": false, "pages": [ "api-reference/events/trigger-event", "api-reference/events/bulk-trigger-event", "api-reference/events/broadcast-event-to-all", "api-reference/events/cancel-triggered-event" ] }, { "group": "Notifications", "expanded": false, "pages": [ "api-reference/notifications/notification-event-schema", "api-reference/notifications/list-all-events", "api-reference/notifications/retrieve-an-event" ] }, { "group": "Messages", "expanded": false, "pages": [ "api-reference/messages/message-schema", "api-reference/messages/list-all-messages", "api-reference/messages/delete-a-message", "api-reference/messages/delete-messages-by-transactionid" ] }, { "group": "Activity", "expanded": false, "pages": ["api-reference/activity/track-activity-and-engagement-events"] } ] }, { "group": "Agents", "icon": "bot", "pages": [ "api-reference/agents/agent-schema", { "group": "Management", "expanded": false, "pages": [ "api-reference/agents/create-an-agent", "api-reference/agents/list-all-agents", "api-reference/agents/retrieve-an-agent", "api-reference/agents/update-an-agent", "api-reference/agents/delete-an-agent" ] }, { "group": "Runtime", "expanded": false, "pages": ["api-reference/agents/update-an-agent-bridge", "api-reference/agents/send-an-agent-reply"] }, { "group": "Integrations", "expanded": false, "pages": [ "api-reference/agents/create-an-agent-integration", "api-reference/agents/list-agent-integrations", "api-reference/agents/update-an-agent-integration", "api-reference/agents/delete-an-agent-integration" ] } ] }, { "group": "Data", "icon": "database", "pages": [ { "group": "Subscribers", "expanded": false, "pages": [ "api-reference/subscribers/subscriber-schema", { "group": "Management", "expanded": false, "pages": [ "api-reference/subscribers/create-a-subscriber", "api-reference/subscribers/retrieve-a-subscriber", "api-reference/subscribers/update-a-subscriber", "api-reference/subscribers/delete-a-subscriber", "api-reference/subscribers/search-subscribers", "api-reference/subscribers/bulk-create-subscribers" ] }, { "group": "Subscriptions", "expanded": false, "pages": ["api-reference/subscribers/retrieve-subscriber-subscriptions"] }, { "group": "Preferences", "expanded": false, "pages": [ "api-reference/subscribers/retrieve-subscriber-preferences", "api-reference/subscribers/update-subscriber-preferences", "api-reference/subscribers/bulk-update-subscriber-preferences" ] }, { "group": "Credentials", "expanded": false, "pages": [ "api-reference/subscribers/update-provider-credentials", "api-reference/subscribers/upsert-provider-credentials", "api-reference/subscribers/delete-provider-credentials" ] }, { "group": "Notification state", "expanded": false, "pages": [ "api-reference/subscribers/retrieve-subscriber-notifications", "api-reference/subscribers/update-notifications-state", "api-reference/subscribers/update-all-notifications-state", "api-reference/subscribers/update-subscriber-online-status", "api-reference/subscribers/retrieve-unseen-notifications-count", "api-reference/subscribers/update-notification-action-status" ] } ] }, { "group": "Inbox", "expanded": false, "pages": [ { "group": "Counts", "expanded": false, "pages": ["api-reference/subscribers/retrieve-subscriber-notifications-count"] }, { "group": "Read & seen", "expanded": false, "pages": [ "api-reference/subscribers/mark-a-notification-as-read", "api-reference/subscribers/mark-a-notification-as-unread", "api-reference/subscribers/mark-all-notifications-as-read", "api-reference/subscribers/mark-notifications-as-seen" ] }, { "group": "Snooze", "expanded": false, "pages": [ "api-reference/subscribers/snooze-a-notification", "api-reference/subscribers/unsnooze-a-notification" ] }, { "group": "Archive", "expanded": false, "pages": [ "api-reference/subscribers/archive-a-notification", "api-reference/subscribers/unarchive-a-notification", "api-reference/subscribers/archive-all-notifications", "api-reference/subscribers/archive-all-read-notifications" ] }, { "group": "Delete", "expanded": false, "pages": [ "api-reference/subscribers/delete-a-notification", "api-reference/subscribers/delete-all-notifications" ] }, { "group": "Actions", "expanded": false, "pages": [ "api-reference/subscribers/complete-a-notification-action", "api-reference/subscribers/revert-a-notification-action" ] } ] }, { "group": "Topics", "expanded": false, "pages": [ "api-reference/topics/topic-schema", { "group": "Management", "expanded": false, "pages": [ "api-reference/topics/create-a-topic", "api-reference/topics/retrieve-a-topic", "api-reference/topics/update-a-topic", "api-reference/topics/delete-a-topic", "api-reference/topics/list-all-topics" ] }, { "group": "Subscriptions", "expanded": false, "pages": [ "api-reference/topics/create-topic-subscriptions", "api-reference/topics/delete-topic-subscriptions", "api-reference/topics/update-a-topic-subscription", "api-reference/topics/list-topic-subscriptions", "api-reference/topics/check-topic-subscriber", "api-reference/topics/retrieve-a-topic-subscription" ] } ] }, { "group": "Contexts", "expanded": false, "pages": [ "api-reference/contexts/context-schema", "api-reference/contexts/create-a-context", "api-reference/contexts/retrieve-a-context", "api-reference/contexts/update-a-context", "api-reference/contexts/delete-a-context", "api-reference/contexts/list-all-contexts" ] }, { "group": "Channel Connections", "expanded": false, "pages": [ "api-reference/channel-connections/create-a-channel-connection", "api-reference/channel-connections/retrieve-a-channel-connection", "api-reference/channel-connections/update-a-channel-connection", "api-reference/channel-connections/delete-a-channel-connection", "api-reference/channel-connections/list-all-channel-connections" ] }, { "group": "Channel Endpoints", "expanded": false, "pages": [ "api-reference/channel-endpoints/create-a-channel-endpoint", "api-reference/channel-endpoints/retrieve-a-channel-endpoint", "api-reference/channel-endpoints/update-a-channel-endpoint", "api-reference/channel-endpoints/delete-a-channel-endpoint", "api-reference/channel-endpoints/list-all-channel-endpoints" ] } ] }, { "group": "Workflows & content", "icon": "git-branch", "pages": [ { "group": "Workflows", "expanded": false, "pages": [ "api-reference/workflows/workflow-schema", "api-reference/workflows/create-a-workflow", "api-reference/workflows/retrieve-a-workflow", "api-reference/workflows/update-a-workflow", "api-reference/workflows/delete-a-workflow", "api-reference/workflows/list-all-workflows", "api-reference/workflows/sync-a-workflow", "api-reference/workflows/retrieve-workflow-step", "api-reference/workflows/generate-a-step-preview" ] }, { "group": "Translations", "expanded": false, "pages": [ "api-reference/translations/create-a-translation", "api-reference/translations/retrieve-a-translation", "api-reference/translations/delete-a-translation", "api-reference/translations/retrieve-a-translation-group", "api-reference/translations/delete-a-translation-group", "api-reference/translations/import-master-translations-json", "api-reference/translations/retrieve-master-translations-json", "api-reference/translations/upload-master-translations-json-file", "api-reference/translations/upload-translation-files" ] }, { "group": "Layouts", "expanded": false, "pages": [ "api-reference/layouts/create-a-layout", "api-reference/layouts/delete-a-layout", "api-reference/layouts/duplicate-a-layout", "api-reference/layouts/generate-layout-preview", "api-reference/layouts/get-layout-usage", "api-reference/layouts/list-all-layouts", "api-reference/layouts/retrieve-a-layout", "api-reference/layouts/update-a-layout" ] } ] }, { "group": "Platform & channels", "icon": "settings", "pages": [ { "group": "Environments", "expanded": false, "pages": [ "api-reference/environments/environment-schema", "api-reference/environments/create-an-environment", "api-reference/environments/update-an-environment", "api-reference/environments/delete-an-environment", "api-reference/environments/list-all-environments", "api-reference/environments/list-environment-tags", "api-reference/environments/compare-resources-between-environments", "api-reference/environments/publish-resources-to-target-environment" ] }, { "group": "Environment Variables", "expanded": false, "pages": [ "api-reference/environment-variables/environment-variable-schema", "api-reference/environment-variables/create-a-variable", "api-reference/environment-variables/retrieve-a-variable", "api-reference/environment-variables/update-a-variable", "api-reference/environment-variables/delete-a-variable", "api-reference/environment-variables/list-all-variables", "api-reference/environment-variables/retrieve-a-variable-usage" ] }, { "group": "Integrations", "expanded": false, "pages": [ "api-reference/integrations/integration-schema", "api-reference/integrations/create-an-integration", "api-reference/integrations/update-an-integration", "api-reference/integrations/delete-an-integration", "api-reference/integrations/list-all-integrations", "api-reference/integrations/list-active-integrations", "api-reference/integrations/update-integration-as-primary", "api-reference/integrations/generate-chat-oauth-url", "api-reference/integrations/auto-configure-an-integration-for-inbound-webhooks" ] } ] } ] }, { "tab": "Resources", "menu": [ { "item": "Guides", "groups": [ { "group": "Use Cases", "pages": [ "guides/use-cases/transactional-notifications", "guides/use-cases/password-reset-notifications", "guides/use-cases/digest-notifications", "guides/use-cases/multi-channel-fallback", "guides/use-cases/notification-preferences" ], "icon": "lightbulb" }, { "group": "Guides", "pages": ["guides", "guides/inngest", "guides/triggerdotdev"], "icon": "book-open" }, { "group": "Inbound Webhooks", "pages": [ "guides/webhooks/clerk", "guides/webhooks/auth0", "guides/webhooks/stripe", "guides/webhooks/segment" ], "icon": "webhook" }, { "group": "Recipes", "pages": ["guides/recipes/managing-workflows", "guides/recipes/supabase-auth-notifications"], "icon": "chef-hat" }, { "group": "Framework", "pages": ["guides/framework/using-translations"], "icon": "blocks" }, { "group": "Migrate to Novu", "pages": [ "guides/migrate-from-courier-to-novu", "guides/migrate-from-knock-to-novu", "guides/migrate-from-magicbell-to-novu", "guides/migrate-from-in-house-to-novu" ], "icon": "arrow-right-left" } ] }, { "item": "Framework", "groups": [ { "group": "Getting Started", "boost": 0.1, "pages": [ "framework", "framework/introduction", { "group": "Quickstart", "pages": [ "framework/quickstart/nextjs", "framework/quickstart/express", "framework/quickstart/remix", "framework/quickstart/nestjs", "framework/quickstart/svelte", "framework/quickstart/nuxt", "framework/quickstart/h3", "framework/quickstart/hono", "framework/quickstart/lambda" ] } ] }, { "group": "Core Concepts", "boost": 0.1, "pages": [ "framework/studio", "framework/endpoint", "framework/tags", "framework/payload", "framework/controls" ], "icon": "blocks" }, { "group": "Channels", "boost": 0.1, "pages": [ "framework/email-channel", "framework/in-app-channel", "framework/push-channel", "framework/sms-channel", "framework/chat-channel" ], "icon": "radio" }, { "group": "Content", "boost": 0.1, "pages": [ "framework/content/react-email", "framework/content/remix-react-email", "framework/content/svelte-email", "framework/content/vue-email" ], "icon": "file-text" }, { "group": "Advanced Features", "boost": 0.1, "pages": ["framework/digest", "framework/delay", "framework/custom", "framework/skip"], "icon": "sparkles" }, { "group": "API Reference", "boost": 0.1, "pages": [ "framework/typescript/overview", "framework/typescript/client", "framework/typescript/workflow", { "group": "Steps", "pages": [ "framework/typescript/steps/chat", "framework/typescript/steps/custom", "framework/typescript/steps/delay", "framework/typescript/steps/digest", "framework/typescript/steps/email", "framework/typescript/steps/inApp", "framework/typescript/steps", "framework/typescript/steps/push", "framework/typescript/steps/sms" ] }, "framework/schema/zod", "framework/schema/json-schema", "framework/schema/class-validator" ], "icon": "code" }, { "group": "Deployment", "boost": 0.1, "pages": [ "framework/deployment/production", "framework/deployment/syncing", "framework/deployment/cli", "framework/deployment/actions" ], "icon": "cloud-upload" } ] }, { "item": "Community", "groups": [ { "group": "Getting Started", "boost": 0.1, "pages": [ "community", { "group": "Self Hosting Novu", "boost": 1, "pages": [ "community/self-hosting-novu/overview", "community/self-hosting-novu/deploy-with-docker", "community/self-hosting-novu/telemetry", "community/self-hosting-novu/data-migrations", "community/self-hosting-novu/v0-to-v2-migration" ] }, "community/get-involved", "community/code-of-conduct", "community/roadmap", "community/changelog", "community/self-hosted-and-novu-cloud", "community/run-in-local-machine", "community/add-a-new-provider" ] } ] } ] } ] }, "navbar": { "links": [ { "label": "Contact Us", "href": "https://novu.co/contact-us" } ], "primary": { "type": "button", "label": "Get Started", "href": "https://dashboard.novu.co/auth/sign-up" } }, "contextual": { "options": ["copy", "view", "cursor", "claude", "chatgpt", "mcp", "add-mcp"] }, "footer": { "socials": { "x": "https://x.com/novuhq", "github": "https://github.com/novuhq/novu", "linkedin": "https://linkedin.com/company/novuhq" }, "links": [ { "header": "Comparison", "items": [ { "label": "Novu vs Courier", "href": "https://novu.co/comparison/courier/" }, { "label": "Novu vs Knock", "href": "https://novu.co/comparison/knock/" }, { "label": "Novu vs MagicBell", "href": "https://novu.co/comparison/magicbell/" }, { "label": "Novu vs SuprSend", "href": "https://novu.co/comparison/suprsend/" }, { "label": "Novu vs In-house", "href": "https://novu.co/comparison/building-in-house/" } ] }, { "header": "Resources", "items": [ { "label": "Contact Support", "href": "mailto:support@novu.co" }, { "label": "Changelog", "href": "https://go.novu.co/changelog?utm_source=docs_footer" }, { "label": "Roadmap", "href": "https://roadmap.novu.co/roadmap" }, { "label": "Contact Sales", "href": "https://novu.co/contact-us/" }, { "label": "Read llms.txt", "href": "/llms.txt" } ] } ] }, "api": { "openapi": "https://spec.speakeasy.com/novu/novu/json-development-with-code-samples", "examples": { "prefill": true } }, "integrations": { "gtm": { "tagId": "GTM-KXMC4XP2" }, "plausible": { "domain": "docs.novu.co" } }, "redirects": [ { "source": "/content-creation-design/handlebars-helpers", "destination": "/platform/templates/handlebars-helpers", "permanent": true }, { "source": "/content-creation-design/layouts", "destination": "/platform/templates/layouts", "permanent": true }, { "source": "/integrations/content/react-email", "destination": "/framework/content/react-email", "permanent": true }, { "source": "/integrations/overview", "destination": "/platform/integrations", "permanent": true }, { "source": "/guides/integrations/segment", "destination": "/platform/integrations/segment", "permanent": true }, { "source": "/platform/integrations/sms/burst-sms", "destination": "/platform/integrations/sms/kudosity", "permanent": true }, { "source": "/guides/add-digest-to-inapp-notifications", "destination": "/platform/workflow/add-and-configure-steps#digest", "permanent": true }, { "source": "/additional-resources/data-migrations", "destination": "/community/data-migrations", "permanent": true }, { "source": "/platform/additional-resources/mcp", "destination": "/platform/build-with-ai/mcp", "permanent": true }, { "source": "/platform/additional-resources/skills", "destination": "/platform/build-with-ai/skills", "permanent": true }, { "source": "/platform/additional-resources/agent-toolkit", "destination": "/platform/build-with-ai/agent-toolkit", "permanent": true }, { "source": "/community/machine-setup", "destination": "/community/run-in-local-machine", "permanent": true }, { "source": "/community/monorepo-structure", "destination": "/community/code-structure", "permanent": true }, { "source": "/platform/inbox/react/get-started", "destination": "/platform/inbox/setup-inbox", "permanent": true }, { "source": "/platform/inbox/prepare-for-production#secure-your-inbox-with-hmac-encryption", "destination": "/platform/inbox/prepare-for-production", "permanent": true }, { "source": "/platform/inbox/react/migration-guide", "destination": "/platform/inbox/migration-guide", "permanent": true }, { "source": "/platform/inbox/react/hooks", "destination": "/platform/sdks/react/hooks/novu-provider", "permanent": true }, { "source": "/platform/inbox/react/components", "destination": "/platform/inbox#composable-architecture", "permanent": true }, { "source": "/platform/inbox/react/components/overview", "destination": "/platform/inbox#composable-architecture", "permanent": true }, { "source": "/platform/inbox/react/components/inbox", "destination": "/platform/inbox", "permanent": true }, { "source": "/platform/inbox/react/components/inbox#data-object", "destination": "/platform/inbox/configuration/data-object", "permanent": true }, { "source": "/platform/inbox/react/components/inbox-content", "destination": "/platform/inbox/advanced-customization/customize-popover#inboxcontent-component", "permanent": true }, { "source": "/platform/inbox/react/components/bell", "destination": "/platform/inbox/advanced-customization/customize-bell", "permanent": true }, { "source": "/platform/inbox/react/components/preferences", "destination": "/platform/inbox/configuration/preferences", "permanent": true }, { "source": "/platform/inbox/react/styling", "destination": "/platform/inbox/configuration/styling", "permanent": true }, { "source": "/platform/inbox/react/styling#appearance-prop", "destination": "/platform/inbox/configuration/styling", "permanent": true }, { "source": "/platform/inbox/react/headless", "destination": "/platform/inbox/headless-mode", "permanent": true }, { "source": "/platform/inbox/react/localization", "destination": "/platform/inbox/advanced-features/localization", "permanent": true }, { "source": "/platform/inbox/advanced-concepts/localization", "destination": "/platform/inbox/advanced-features/localization", "permanent": true }, { "source": "/platform/inbox/advanced-concepts/multi-tenancy", "destination": "/platform/inbox/advanced-features/multi-tenancy", "permanent": true }, { "source": "/inbox/overview", "destination": "/platform/inbox", "permanent": true }, { "source": "/inbox/react/styling", "destination": "/platform/inbox/configuration/styling", "permanent": true }, { "source": "/sdks/overview", "destination": "/platform/sdks", "permanent": true }, { "source": "/get-started", "destination": "/platform/quickstart/nextjs", "permanent": true }, { "source": "/getting-started", "destination": "/platform/quickstart/nextjs", "permanent": true }, { "source": "/getting-started/:slug*", "destination": "/platform/quickstart/nextjs", "permanent": true }, { "source": "/quickstart", "destination": "/platform/quickstart/nextjs", "permanent": true }, { "source": "/quickstart/nextjs", "destination": "/platform/quickstart/nextjs", "permanent": true }, { "source": "/platform/overview", "destination": "/platform", "permanent": true }, { "source": "/guides/overview", "destination": "/guides", "permanent": true }, { "source": "/framework/overview", "destination": "/framework", "permanent": true }, { "source": "/community/overview", "destination": "/community", "permanent": true }, { "source": "/api", "destination": "/api-reference", "permanent": true }, { "source": "/api-reference/overview", "destination": "/api-reference", "permanent": true }, { "source": "/api-reference/auth", "destination": "/api-reference/authentication", "permanent": true }, { "source": "/platform/workflow/overview", "destination": "/platform/workflow", "permanent": true }, { "source": "/platform/workflows/notification-workflows", "destination": "/platform/workflow", "permanent": true }, { "source": "/platform/sdks/overview", "destination": "/platform/sdks", "permanent": true }, { "source": "/platform/inbox/overview", "destination": "/platform/inbox", "permanent": true }, { "source": "/platform/integrations/overview", "destination": "/platform/integrations", "permanent": true }, { "source": "/platform/subscription/overview", "destination": "/platform/subscription", "permanent": true }, { "source": "/platform/sdks/react/overview", "destination": "/platform/sdks/react", "permanent": true }, { "source": "/platform/workflow/layouts", "destination": "/platform/workflow/add-notification-content/channels-template-editors#email-layouts", "permanent": true }, { "source": "/platform/workflow/template-editor", "destination": "/platform/workflow/add-notification-content/channels-template-editors", "permanent": true }, { "source": "/platform/workflow/build-a-workflow", "destination": "/platform/workflow/create-a-workflow", "permanent": true }, { "source": "/platform/workflow/build-a-workflow#manage-payload-schema", "destination": "/platform/workflow/configure-workflow#payload-schema", "permanent": true }, { "source": "/platform/workflow/delay", "destination": "/platform/workflow/add-and-configure-steps#delay", "permanent": true }, { "source": "/platform/workflow/digest", "destination": "/platform/workflow/add-and-configure-steps#digest", "permanent": true }, { "source": "/platform/workflow/throttle-step", "destination": "/platform/workflow/add-and-configure-steps#throttle", "permanent": true }, { "source": "/platform/workflow/step-conditions", "destination": "/platform/workflow/add-and-configure-steps/step-conditions", "permanent": true }, { "source": "/platform/workflow/channel-steps", "destination": "/platform/workflow/add-and-configure-steps#channel-steps", "permanent": true }, { "source": "/platform/workflow/tags", "destination": "/platform/workflow/configure-workflow#tags", "permanent": true }, { "source": "/community/project-differences", "destination": "/community/self-hosted-and-novu-cloud", "permanent": true }, { "source": "/platform/concepts/endpoint", "destination": "/framework/endpoint", "permanent": true }, { "source": "/platform/concepts/environments", "destination": "/platform/developer/environments", "permanent": true }, { "source": "/platform/concepts/notifications", "destination": "/platform/concepts/notification-event", "permanent": true }, { "source": "/platform/additional-resources/roles-and-permissions", "destination": "/platform/account/roles-and-permissions", "permanent": true }, { "source": "/platform/inbox/headless/api-reference", "destination": "/platform/inbox/headless-mode", "permanent": true }, { "source": "/platform/inbox/headless/get-started", "destination": "/platform/inbox/headless-mode", "permanent": true }, { "source": "/platform/inbox/react/tabs", "destination": "/platform/inbox/configuration/tabs", "permanent": true }, { "source": "/platform/integrations/demo-providers", "destination": "/platform/integrations/demo-integration", "permanent": true }, { "source": "/platform/integrations/email/outlook-365", "destination": "/platform/integrations/email/outlook365", "permanent": true }, { "source": "/platform/integrations/email/email-webhook", "destination": "/platform/integrations/email/webhook", "permanent": true }, { "source": "/platform/integrations/email/sendinblue", "destination": "/platform/integrations/email/brevo", "permanent": true }, { "source": "/platform/integrations/email/maqsam", "destination": "/platform/integrations/sms/maqsam", "permanent": true }, { "source": "/channels/email/email-webhook", "destination": "/platform/integrations/email/webhook", "permanent": true }, { "source": "/platform/integrations/sms/azure-sms", "destination": "/platform/integrations/sms/azure", "permanent": true }, { "source": "/platform/integrations/sms/bulksms", "destination": "/platform/integrations/sms/bulk-sms", "permanent": true }, { "source": "/channels/sms/generic-sms", "destination": "/platform/integrations/sms/sms-webhook", "permanent": true }, { "source": "/platform/integrations/sms/sns", "destination": "/platform/integrations/sms/aws-sns", "permanent": true }, { "source": "/channels/sms/azure", "destination": "/platform/integrations/sms/azure", "permanent": true }, { "source": "/channels/sms/simpletexting", "destination": "/platform/integrations/sms/simpletexting", "permanent": true }, { "source": "/integrations/providers/sms/generic-sms", "destination": "/platform/integrations/sms/sms-webhook", "permanent": true }, { "source": "/platform/subscription/Headless-hooks", "destination": "/platform/subscription/headless-hooks", "permanent": true }, { "source": "/platform/workflow/add-notification-content", "destination": "/platform/workflow/add-notification-content/channels-template-editors", "permanent": true }, { "source": "/platform/workflow/translations", "destination": "/platform/workflow/advanced-features/translations", "permanent": true }, { "source": "/platform/workflow/add-and-configure-steps/action-steps/delay", "destination": "/platform/workflow/add-and-configure-steps/configure-action-steps/delay", "permanent": true }, { "source": "/platform/workflow/add-and-configure-steps/action-steps/throttle", "destination": "/platform/workflow/add-and-configure-steps/configure-action-steps/throttle", "permanent": true }, { "source": "/platform/framework/typescript/steps", "destination": "/framework/typescript/steps", "permanent": true }, { "source": "/framework/steps", "destination": "/framework/typescript/steps", "permanent": true }, { "source": "/platform/run-in-local-machine", "destination": "/community/run-in-local-machine", "permanent": true }, { "source": "/platform/workflow/workflows.mdx", "destination": "/platform/workflow", "permanent": true }, { "source": "/docs/platform/workflow/layouts", "destination": "/platform/workflow/add-notification-content/channels-template-editors#email-layouts", "permanent": true }, { "source": "/agents/get-started/quickstart", "destination": "/agents/get-started/ai-sdk", "permanent": true }, { "source": "/agents/quickstart/ai-sdk", "destination": "/agents/get-started/ai-sdk", "permanent": true }, { "source": "/agents/quickstart/langchain", "destination": "/agents/get-started/langchain", "permanent": true }, { "source": "/agents/quickstart/mastra", "destination": "/agents/get-started/mastra", "permanent": true }, { "source": "/agents/quickstart/claude-managed", "destination": "/agents/get-started/claude-managed", "permanent": true }, { "source": "/agents/quickstart/aws-claude", "destination": "/agents/get-started/aws-claude", "permanent": true }, { "source": "/agents/managed-agent/quickstart", "destination": "/agents/get-started/claude-managed", "permanent": true }, { "source": "/agents/quickstart/managed", "destination": "/agents/get-started/claude-managed", "permanent": true }, { "source": "/agents/custom-code-agent/quickstart", "destination": "/agents/get-started/ai-sdk", "permanent": true }, { "source": "/agents/quickstart/shared-onboarding", "destination": "/agents/get-started/ai-sdk", "permanent": true }, { "source": "/agents/channels", "destination": "/agents/channels/overview", "permanent": true }, { "source": "/agents/channels/capabilities", "destination": "/agents/channels/overview", "permanent": true }, { "source": "/agents/custom-code-agent/build-your-first-agent", "destination": "/agents/custom-code-agent/frameworks/ai-sdk", "permanent": true }, { "source": "/agents/custom-code-agent/connect-your-first-agent", "destination": "/agents/custom-code-agent/frameworks/ai-sdk", "permanent": true }, { "source": "/agents/custom-code-agent/frameworks/overview", "destination": "/agents/custom-code-agent/frameworks/ai-sdk", "permanent": true }, { "source": "/agents/custom-code-agent/connect-your-first-agent/ai-sdk", "destination": "/agents/custom-code-agent/frameworks/ai-sdk", "permanent": true }, { "source": "/agents/custom-code-agent/connect-your-first-agent/your-own-code", "destination": "/agents/custom-code-agent/frameworks/other", "permanent": true }, { "source": "/agents/custom-code-agent/frameworks/your-own-code", "destination": "/agents/custom-code-agent/frameworks/other", "permanent": true }, { "source": "/agents/custom-code-agent/setup-your-agent/overview", "destination": "/agents/get-started/ai-sdk", "permanent": true }, { "source": "/agents/custom-code-agent/setup-your-agent/create-an-agent", "destination": "/agents/get-started/ai-sdk", "permanent": true }, { "source": "/agents/custom-code-agent/setup-your-agent/scaffold-your-project", "destination": "/agents/get-started/ai-sdk", "permanent": true }, { "source": "/agents/custom-code-agent/setup-your-agent/handle-events", "destination": "/agents/custom-code-agent/building-blocks/handle-events", "permanent": true }, { "source": "/agents/custom-code-agent/setup-your-agent/reply", "destination": "/agents/custom-code-agent/building-blocks/reply", "permanent": true }, { "source": "/agents/custom-code-agent/setup-your-agent/edit-sent-messages", "destination": "/agents/custom-code-agent/building-blocks/edit-sent-messages", "permanent": true }, { "source": "/agents/custom-code-agent/setup-your-agent/signals", "destination": "/agents/custom-code-agent/building-blocks/signals", "permanent": true }, { "source": "/agents/custom-code-agent/setup-your-agent/connect-components", "destination": "/agents/custom-code-agent/connect-components", "permanent": true } ] }