mint.json

{
  "$schema": "https://mintlify.com/schema.json",
  "theme": "venus",
  "name": "Novu",
  "logo": {
    "dark": "/logo/logo-dark-bg.svg",
    "light": "/logo/logo-light-bg.svg"
  },
  "modeToggle": {
    "default": "light"
  },
  "openapi": "https://api.novu.co/openapi.json",
  "favicon": "/favicon.png",

  "colors": {
    "primary": "#03a9ca",
    "light": "#03a9ca",
    "dark": "#03a9ca",
    "background": {
      "dark": "#000000",
      "light": "#ffffff"
    }
  },
  "background": {
    "style": "windows"
  },
  "feedback": {
    "thumbsRating": true,
    "suggestEdit": true,
    "raiseIssue": true
  },
  "topbarLinks": [
    {
      "name": "Blog",
      "url": "https://novu.co/blog/?utm_campaign=docs_top_nav"
    },
    {
      "name": "Contact us",
      "url": "https://novu.co/contact-us-docs/?utm_campaign=docs_top_nav"
    }
  ],
  "topbarCtaButton": {
    "name": "Try Novu",
    "url": "https://dashboard-v2.novu.co/?utm_campaign=docs_top_bar_tn",
    "style": "pill",
    "arrow": true
  },
  "codeBlock": {
    "mode": "auto"
  },
  "primaryTab": {
    "name": "Platform"
  },
  "tabs": [

    {
      "name": "<Inbox />",
      "url": "inbox"
    },
    {
      "name": "Framework",
      "url": "framework"
    },
    {
      "name": "Community",
      "url": "community"
    },
    {
      "name": "API Reference",
      "url": "api-reference"
    }
  ],
  "navigation": [
    {
      "group": "Get started",
      "pages": [
        "getting-started/how-novu-works",
        "getting-started/quickstart"
      ]
    },
    {
      "group": "Novu for...",
      "pages": [
        "getting-started/novu-for/developers",
        "getting-started/novu-for/product"
      ]
    },
    {
      "group": "Get started",
      "pages": [
        "framework/overview",
        {
          "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/lambda"
          ]
        }
      ]
    },
    {
      "group": "Concepts",
      "pages": [
        "framework/studio",
        "framework/endpoint",
        "framework/controls"
      ]
    },
    {
      "group": "Concepts",
      "pages": [
        "concepts/workflows",
        "concepts/notifications",
        "concepts/trigger",
        "concepts/subscribers",
        "concepts/endpoint",
        "concepts/environments",
        "concepts/preferences",
        "concepts/topics",
        "concepts/tenants",
        "concepts/integrations"
      ]
    },
    {
      "group": "Build workflows",
      "pages": [
        "workflow/overview",
        "workflow/how-to/build-a-workflow",
        "workflow/template-editor",
        "workflow/digest",
        "workflow/delay",
        "workflow/custom",
        "workflow/tags",
        "workflow/step-conditions",
        "workflow/channel-steps"
      ]
    },
    {
      "group": "Channels",
      "pages": [
        {
          "group": "In-App",
          "icon": "bell",
          "pages": [
            "integrations/providers/in-app/overview",
            "integrations/providers/in-app/adding-in-app"
        ]
        },
        {
          "group": "Email",
          "icon": "envelope",
          "pages": [
            "integrations/providers/email/overview",
            "integrations/providers/email/adding-email",
            {
              "group": "Providers",
              "pages": [
                "integrations/providers/email/sendgrid",
                "integrations/providers/email/amazon-ses",
                "integrations/providers/email/postmark",
                "integrations/providers/email/resend",
                "integrations/providers/email/sendinblue",
                "integrations/providers/email/mailersend",
                "integrations/providers/email/mailgun",
                "integrations/providers/email/mailjet",
                "integrations/providers/email/infobip",
                "integrations/providers/email/mailtrap",
                "integrations/providers/email/mandrill",
                "integrations/providers/email/netcore",
                "integrations/providers/email/outlook365",
                "integrations/providers/email/braze",
                "integrations/providers/email/sparkpost",
                "integrations/providers/email/plunk",
                "integrations/providers/email/custom-smtp"
              ]
            }
          ]
        },
        {
          "group": "SMS",
          "icon": "message-sms",
          "pages": [
            "integrations/providers/sms/overview",
            "integrations/providers/sms/adding-sms",
            { 
              "group": "Providers",
              "pages": [
                "integrations/providers/sms/twilio",
                "integrations/providers/sms/sms77",
                "integrations/providers/sms/africas-talking",
                "integrations/providers/sms/azure",
                "integrations/providers/sms/bulk-sms",
                "integrations/providers/sms/messagebird",
                "integrations/providers/sms/simpletexting",
                "integrations/providers/sms/infobip",
                "integrations/providers/sms/sendchamp",
                "integrations/providers/sms/aws-sns",
                "integrations/providers/sms/nexmo",
                "integrations/providers/sms/plivo",
                "integrations/providers/sms/telnyx",
                "integrations/providers/sms/termii",
                "integrations/providers/sms/firetext",
                "integrations/providers/sms/gupshup",
                "integrations/providers/sms/clickatell"
              ]
            }
          ]
        },
        {
          "group": "Push",
          "icon": "mobile",
          "pages": [
            "integrations/providers/push/overview",
            "integrations/providers/push/adding-push",
            {
              "group": "Providers",
              "pages": [
                "integrations/providers/push/fcm",
                "integrations/providers/push/apns",
                "integrations/providers/push/expo-push",
                "integrations/providers/push/onesignal",
                "integrations/providers/push/pushpad",
                "integrations/providers/push/push-webhook",
                "integrations/providers/push/pusher-beams"
              ]
            }
          ]
        },
        {
          "group": "Chat",
          "icon": "comments",
          "pages": [
            "integrations/providers/chat/overview",
            "integrations/providers/chat/adding-chat",
            {
              "group": "Providers",
              "pages": [
                "integrations/providers/chat/discord",
                "integrations/providers/chat/slack",
                "integrations/providers/chat/ms-teams",
                "integrations/providers/chat/zulip",
                "integrations/providers/chat/whats-app"
              ]
            }
          ]
        }
      ]
    },
    {
      "group": "Get Started",
      "pages": [
        "inbox/overview"
      ]
    },
    {
      "group": "React",
      "icon": "react",
      "pages": [
        "inbox/react/get-started",
        "inbox/react/styling",
        "inbox/react/multiple-tabs",
        {
          "group": "Components",
          "pages": [
            "inbox/react/components/overview",
            "inbox/react/components/inbox",
            "inbox/react/components/bell",
            "inbox/react/components/notifications",
            "inbox/react/components/preferences",
            "inbox/react/components/inbox-content"
          ]
        },
        {
          "group": "Hooks",
          "pages": [
            "inbox/react/hooks/overview",
            "inbox/react/hooks/novu-provider",
            "inbox/react/hooks/use-notifications",
            "inbox/react/hooks/use-preferences",
            "inbox/react/hooks/use-counts",
            "inbox/react/hooks/use-novu"
          ]
        },
        "inbox/react/localization",
        "inbox/react/production",
        "inbox/react/migration-guide"
      ]
    },
    {
      "group": "Headless",
      "icon": "js",
      "pages": [
        "inbox/headless/get-started",
        "inbox/headless/api-reference"
      ]
    },
    {
      "group": "React Native",
      "icon": "mobile",
      "pages": [
        "inbox/react-native/quickstart",
        {
          "group": "Hooks",
          "pages": [
            "inbox/react-native/hooks/novu-provider",
            "inbox/react-native/hooks/use-notifications",
            "inbox/react-native/hooks/use-preferences",
            "inbox/react-native/hooks/use-counts",
            "inbox/react-native/hooks/use-novu"
          ]
        }
      ]
    },
    {
      "group": "Build workflows",

      "pages": [
        "framework/overview",
        "framework/tags",
        "framework/digest",
        "framework/delay",
        "framework/custom",
        "framework/in-app-channel",
        "framework/email-channel",
        "framework/push-channel",
        "framework/sms-channel",
        "framework/chat-channel"
      ]
    },
    {
      "group": "Deploy",
      "pages": [
        "framework/deployment/syncing",
        "framework/deployment/production",
        {
          "group": "Platforms",
          "pages": [
            "framework/deployment/cli",
            "framework/deployment/actions"
          ]
        }
      ]
    },
    {
      "group": "Get Started",
      "pages": [
        "community/overview",
        "community/project-differences"
      ]
    },
    {
      "group": "Self Hosting Novu",
      "pages": [
        "community/self-hosting-novu/overview",
        "community/self-hosting-novu/deploy-with-docker",
        "community/self-hosting-novu/telemetry"
      ]
    },
    {
      "group": "Community",
      "pages": [
        "community/code-of-conduct",
        "community/get-involved",
        "community/changelog",
        "community/roadmap",
        {
          "group": "Machine setup",
          "pages": [
            "community/machine-setup",
            "community/windows-machine-setup"
          ]
        },
        "community/run-in-local-machine",
        "community/feature-flags",
        "community/monorepo-structure",
        "community/add-a-new-provider"
      ]
    },
    {
      "group": "SDK Reference",
      "pages": [
        "framework/typescript/overview",
        "framework/typescript/client",
        "framework/typescript/workflow",
        {
          "group": "Steps",
          "pages": [
            "framework/typescript/steps/overview",
            "framework/typescript/steps/email",
            "framework/typescript/steps/inApp",
            "framework/typescript/steps/sms",
            "framework/typescript/steps/push",
            "framework/typescript/steps/chat",
            "framework/typescript/steps/digest",
            "framework/typescript/steps/delay",
            "framework/typescript/steps/custom"
          ]
        }
      ]
    },
    {
      "group": "SDKs",
      "pages": [
        "sdks/overview",
        {
          "group": "Backend",
          "pages": [
            "sdks/nodejs",
            "sdks/php",
            "sdks/laravel",
            "sdks/python",
            "sdks/kotlin",
            "sdks/java",
            "sdks/ruby",
            "sdks/go",
            "sdks/dotnet"
          ]
        }
      ]
    },
    {
      "group": "Account",
      "pages": [
        "account/authentication",
        "account/sso",
        "account/billing"
      ]
    },
    {
      "group": "Additional Resources",
      "pages": [
        {
          "group": "Recipes",
          "icon": "notebook",
          "pages": [
            "recipes/workflows/introduction",
            "recipes/workflows/otp",
            "recipes/workflows/password-reset",
            "recipes/workflows/recent-login",
            "recipes/workflows/invoice-receipt",
            "recipes/workflows/shipping-confirmation",
            "recipes/workflows/feedback-reviews",
            "recipes/workflows/multi-workflow-digest",
            "recipes/workflows/translations",
            "integrations/segment"
          ]
        },
        "additional-resources/security",
        "additional-resources/idempotency",
        "additional-resources/data-migrations",
        "additional-resources/glossary"
      ]
    },
    {
      "group": "API Reference",
      "pages": [
        "api-reference/overview",
        "api-reference/rate-limiting",
        {
          "group": "Events",
          "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": "Subscribers",
          "pages": [
            "api-reference/subscribers/get-subscribers",
            "api-reference/subscribers/create-subscriber",
            "api-reference/subscribers/bulk-create-subscribers",
            "api-reference/subscribers/get-subscriber",
            "api-reference/subscribers/update-subscriber",
            "api-reference/subscribers/delete-subscriber",
            "api-reference/subscribers/update-subscriber-credentials",
            "api-reference/subscribers/delete-subscriber-credentials-by-providerid",
            "api-reference/subscribers/update-subscriber-online-status",
            "api-reference/subscribers/get-subscriber-preferences",
            "api-reference/subscribers/get-subscriber-global-preferences",
            "api-reference/subscribers/update-subscriber-preference",
            "api-reference/subscribers/update-subscriber-global-preference",
            "api-reference/subscribers/get-in-app-notification-feed-for-a-particular-subscriber",
            "api-reference/subscribers/get-the-unseen-in-app-notifications-count-for-subscribers-feed",
            "api-reference/subscribers/mark-a-subscriber-feed-message-as-seen",
            "api-reference/subscribers/marks-all-the-subscriber-messages-as-read-unread-seen-or-unseen-optionally-you-can-pass-feed-id-or-array-to-mark-messages-of-a-particular-feed",
            "api-reference/subscribers/mark-message-action-as-seen",
            "api-reference/subscribers/handle-providers-oauth-redirect",
            "api-reference/subscribers/handle-chat-oauth"
          ]
        },
        {
          "group": "Topics",
          "pages": [
            "api-reference/topics/filter-topics",
            "api-reference/topics/topic-creation",
            "api-reference/topics/subscribers-addition",
            "api-reference/topics/check-topic-subscriber",
            "api-reference/topics/subscribers-removal",
            "api-reference/topics/get-topic",
            "api-reference/topics/delete-topic",
            "api-reference/topics/rename-a-topic"
          ]
        },
        {
          "group": "Notification",
          "pages": [
            "api-reference/notification/get-notifications",
            "api-reference/notification/get-notification-statistics",
            "api-reference/notification/get-notification-graph-statistics",
            "api-reference/notification/get-notification"
          ]
        },
        {
          "group": "Workflows",
          "pages": [
            "api-reference/workflows/get-workflows",
            "api-reference/workflows/create-workflow",
            "api-reference/workflows/get-workflow",
            "api-reference/workflows/update-workflow",
            "api-reference/workflows/delete-workflow",
            "api-reference/workflows/update-workflow-status"
          ]
        },
        {
          "group": "Workflow overrides",
          "pages": [
            "api-reference/workflow-overrides/create-workflow-overrides",
            "api-reference/workflow-overrides/get-workflow-overrides",
            "api-reference/workflow-overrides/get-workflow-override",
            "api-reference/workflow-overrides/get-workflow-override-by-id",
            "api-reference/workflow-overrides/update-workflow-override-by-id",
            "api-reference/workflow-overrides/update-workflow-override",
            "api-reference/workflow-overrides/delete-workflow-override"
          ]
        },
        {
          "group": "Workflow groups",
          "pages": [
            "api-reference/workflow-groups/get-workflow-groups",
            "api-reference/workflow-groups/create-workflow-group",
            "api-reference/workflow-groups/get-workflow-group",
            "api-reference/workflow-groups/delete-workflow-group",
            "api-reference/workflow-groups/update-workflow-group"
          ]
        },
        {
          "group": "Integrations",
          "pages": [
            "api-reference/integrations/get-integrations",
            "api-reference/integrations/create-integration",
            "api-reference/integrations/get-active-integrations",
            "api-reference/integrations/get-webhook-support-status-for-provider",
            "api-reference/integrations/update-integration",
            "api-reference/integrations/delete-integration",
            "api-reference/integrations/set-integration-as-primary"
          ]
        },
        {
          "group": "Layouts",
          "pages": [
            "api-reference/layouts/filter-layouts",
            "api-reference/layouts/layout-creation",
            "api-reference/layouts/get-layout",
            "api-reference/layouts/delete-layout",
            "api-reference/layouts/update-a-layout",
            "api-reference/layouts/set-default-layout"
          ]
        },
        {
          "group": "Environments",
          "pages": [
            "api-reference/environments/get-current-environment",
            "api-reference/environments/get-environments",
            "api-reference/environments/get-api-keys",
            "api-reference/environments/regenerate-api-keys"
          ]
        },
        {
          "group": "Changes",
          "pages": [
            "api-reference/changes/get-changes",
            "api-reference/changes/get-changes-count",
            "api-reference/changes/apply-changes",
            "api-reference/changes/apply-change"
          ]
        },
        {
          "group": "Execution details",
          "pages": [
            "api-reference/execution-details/get-execution-details"
          ]
        },
        {
          "group": "Feeds",
          "pages": [
            "api-reference/feeds/get-feeds",
            "api-reference/feeds/create-feed",
            "api-reference/feeds/delete-feed"
          ]
        },
        {
          "group": "Tenants",
          "pages": [
            "api-reference/tenants/get-tenants",
            "api-reference/tenants/create-tenant",
            "api-reference/tenants/get-tenant",
            "api-reference/tenants/update-tenant",
            "api-reference/tenants/delete-tenant"
          ]
        },
        {
          "group": "Organizations",
          "pages": [
            "api-reference/organizations/create-organization",
            "api-reference/organizations/get-all-organizations",
            "api-reference/organizations/get-all-members-of-current-organization",
            "api-reference/organizations/get-current-organization",
            "api-reference/organizations/rename-organization",
            "api-reference/organizations/update-member-role-to-admin",
            "api-reference/organizations/update-organization-branding",
            "api-reference/organizations/delete-member-from-organization"
          ]
        },
        {
          "group": "Messages",
          "pages": [
            "api-reference/messages/get-messages",
            "api-reference/messages/delete-message",
            "api-reference/messages/delete-message-by-transactionid"
          ]
        }
      ]
    },
    {
      "group": "Integrations",
      "pages": [
        {
          "group": "Content",
          "pages": [
            "framework/content/react-email",
            "framework/content/vue-email",
            "framework/content/svelte-email",
            "framework/content/remix-react-email"
          ]
        },
        {
          "group": "Schema",
          "pages": [
            "framework/schema/zod",
            "framework/schema/json-schema"
          ]
        }
      ]
    }
  ],
  "redirects": [
    {
      "source": "/api/client-libraries",
      "destination": "/sdks/introduction"
    },
    {
      "source": "/framework/introduction",
      "destination": "/framework/quickstart"
    },
    {
      "source": "/echo/quickstart",
      "destination": "/getting-started/introduction"
    },
    {
      "source": "/echo/:slug*",
      "destination": "/framework/:slug*"
    },
    {
      "source": "/guides/echo-guides/:slug*",
      "destination": "/guides/framework-guides/:slug*"
    },
    {
      "source": "/guides/echo-guides/echo-mjml",
      "destination": "/guides/framework-guides/framework-mjml"
    },
    {
      "source": "/guides/echo-guides/echo-nuxt-vuemail",
      "destination": "/guides/framework-guides/framework-nuxt-vuemail"
    },
    {
      "source": "/guides/echo-guides/echo-react-email",
      "destination": "/guides/framework-guides/framework-react-email"
    },
    {
      "source": "/guides/echo-guides/echo-remix",
      "destination": "/guides/framework-guides/framework-remix"
    },
    {
      "source": "/guides/integrations/segment",
      "destination": "/integrations/segment"
    },
    {
      "source": "/guides/echo-guides/echo-svelte",
      "destination": "/guides/framework-guides/framework-svelte"
    },
    {
      "source": "/guides/workflows/introduction",
      "destination": "/recipes/workflows/introduction"
    },
    {
      "source": "/guides/workflows/otp",
      "destination": "/recipes/workflows/otp"
    },
    {
      "source": "/guides/workflows/password-reset",
      "destination": "/recipes/workflows/password-reset"
    },
    {
      "source": "/guides/workflows/recent-login",
      "destination": "/recipes/workflows/recent-login"
    },
    {
      "source": "/guides/workflows/invoice-receipt",
      "destination": "/recipes/workflows/invoice-receipt"
    },
    {
      "source": "/guides/workflows/shipping-confirmation",
      "destination": "/recipes/workflows/shipping-confirmation"
    },
    {
      "source": "/guides/workflows/feedback-reviews",
      "destination": "/recipes/workflows/feedback-reviews"
    },
    {
      "source": "/channels-and-providers/push/fcm",
      "destination": "/integrations/providers/push/fcm"
    },
    {
      "source": "/self-hosting-novu/deploy-with-docker",
      "destination": "/community/deploy-with-docker"
    },
    {
      "source": "/notification-center/client/react/api-reference",
      "destination": "/inbox/react/api-reference"
    },
    {
      "source": "/subscribers/subscribers",
      "destination": "/concepts/subscribers"
    },
    {
      "source": "/quickstarts/react",
      "destination": "/inbox/react/get-started"
    },
    {
      "source": "/notification-center/client/react/customization",
      "destination": "inbox/react/styling"
    },
    {
      "source": "/channels-and-providers/push/overview",
      "destination": "/integrations/providers/push/overview"
    },
    {
      "source": "/workflows/notification-workflows",
      "destination": "/concepts/workflows"
    },
    {
      "source": "/channels-and-providers/sms/nexmo",
      "destination": "/integrations/providers/sms/nexmo"
    },
    {
      "source": "/channels-and-providers/:slug*",
      "destination": "/integrations/providers/:slug*"
    },
    {
      "source": "/notification-center/introduction",
      "destination": "/inbox/overview"
    },
    {
      "source": "/sdks/introduction",
      "destination": "/sdks/framework/typescript/overview"
    },
    {
      "source": "/subscribers/topics",
      "destination": "/concepts/topics"
    },
    {
      "source": "/platform/environments",
      "destination": "/concepts/environments"
    },
    {
      "source": "/tenants/introduction",
      "destination": "/concepts/tenants"
    },
    {
      "source": "/guides/how-to-integrate-segment-with-novu",
      "destination": "/guides/integrations/segment"
    },
    {
      "source": "/how-to/introduction",
      "destination": "/guides/workflows/introduction"
    }
  ],
  "footer": {
    "socials": {
      "twitter": "https://twitter.com/novuhq",
      "github": "https://github.com/novuhq",
      "linkedin": "https://www.linkedin.com/company/novuco",
      "discord": "https://discord.gg/novu",
      "youtube": "https://www.youtube.com/@novuhq"
    },
    "links": [
      {
        "title": "Learn",
        "links": [
          {
            "label": "Blog",
            "url": "https://novu.co/blog"
          },
          {
            "label": "Changelog",
            "url": "https://roadmap.novu.co/changelog"
          },
          {
            "label": "Roadmap",
            "url": "https://roadmap.novu.co"
          }
        ]
      }
    ]
  },
  "api": {
    "baseUrl": [
      "https://api.novu.co",
      "https://eu.api.novu.co"
    ],
    "auth": {
      "method": "key",
      "name": "Authorization",
      "inputPrefix": "ApiKey"
    }
  },
  "integrations": {
    "intercom": "fqe0apnx"
  },
  "analytics": {
    "plausible": {
      "domain": "docs.novu.co"
    }
  },
  "versions": [
    "v2.x",
    {
      "name": "v0.x",
      "url": "https://v0.x-docs.novu.co"
    }
  ],
  "metadata": {
    "og:image": "https://novu.co/images/social-preview.jpg"
  }
}