From 683a317cef06f326d34ee8cd9d798301e513721b Mon Sep 17 00:00:00 2001 From: Aviatorscode2 Date: Wed, 29 Oct 2025 20:44:51 +0100 Subject: [PATCH 01/25] Docs for Email home page --- .../platform/integrations/email/index.mdx | 207 ++++++++++++------ .../platform/integrations/email/meta.json | 2 +- 2 files changed, 138 insertions(+), 71 deletions(-) diff --git a/content/docs/platform/integrations/email/index.mdx b/content/docs/platform/integrations/email/index.mdx index 9584cffcf..ce03bb26d 100644 --- a/content/docs/platform/integrations/email/index.mdx +++ b/content/docs/platform/integrations/email/index.mdx @@ -4,78 +4,96 @@ title: 'E-mail' description: 'Learn how to configure the Email channel' --- -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Step, Steps } from 'fumadocs-ui/components/steps'; -The Email Channel is a critical component for delivering notifications reliably. Whether it's a password reset, an onboarding email, or an alert about account activity, email remains a trusted medium for reaching users. -Novu simplifies this process, allowing you to focus on implementation rather than infrastructure. +Email providers are the services that deliver notifications to your subscribers’ email. Each provider must be set up individually in the Novu dashboard to enable delivery through the Email channel. -## Key Features +Novu provides a unified integration layer that connects your workflows to these email providers. Once you’ve added your integrations, Novu handles routing and delivery automatically, sending each email through the correct provider without requiring additional setup. This makes it easy to manage multiple email integrations, and switch providers when needed. -- **Multi-Provider Support**: Integrate any major provider like SendGrid, SES, or Mailgun -- **Failover Mechanisms**: Automatically retry with a backup provider to ensure reliability -- **Customizable Templates**: Leverage templates with dynamic placeholders to personalize messages -- **Delivery Insights (Coming Soon)**: Track delivery status, open rates, and more in the Novu dashboard +## Key features -## Common Use Cases +- **Multi-provider support**: Integrate any major provider like SendGrid, SES, or Mailgun +- **Failover mechanisms**: Automatically retry with a backup provider to ensure reliability +- **Activity tracking**: Track delivery status, open rates, and more in the Novu dashboard -- **Transactional Emails**: Password resets, account verification, purchase confirmations -- **System Alerts**: Security notifications, system updates -- **Engagement Emails**: Onboarding, reminders, promotional updates +## How Email works in Novu -Novu can be used to deliver email messages to your subscribers using a unified delivery API. You can easily integrate your favorite email provider using the built-in integration store. +Here’s the typical flow for sending an email notification through Novu: + + + + + +### Add an email provider + +Start by adding an email provider in the **Integration Store** on your Novu dashboard. You can connect one or more integrations for the different or the same providers. + +To learn how to add an email provider, refer to the guide for the supported providers. + + + +### Add the email channel to your workflow + +Next, include an Email step in a workflow. This step defines when and how an email should be sent as part of your notification workflow. + + +### Define the email content + +Within the Email step, you can design your message using the built-in visual editor or code editor (for custom HTML and templating with LiquidJS). +Novu supports dynamic data from your payload, so each message can be personalized for the subscriber. + + +### Store subscriber email addresses + +Novu automatically sends the notification to the email address stored on the . You must ensure this field is set for any subscriber who needs to receive emails. You can store or update this using the Novu dashboard, SDK or API. + + +### Trigger the workflow + +Finally, trigger the workflow from your application code by sending an event to Novu. +Novu automatically resolves the subscriber, selects the correct provider, renders the email template, and delivers the message through the configured email integration. + + + + Looking to build your email template? Learn how to use the block editor, custom HTML, and dynamic variables in our guide. ## Configuring email providers -When creating an email provider integration you will be asked to provide additional fields alongside the provider-specific credentials: +When you add an email provider in the **Integration Store**, you'll configure settings that are common to all email providers, as well as credentials specific to that provider. -- **Sender name** - Will be displayed as the sender of the message -- **From email address** - Emails sent using Novu will be sent using this address +### Default sender settings -For some email providers including SendGrid you will have to authenticate the **From email address** to make sure you will send email messages using an authorized address. +Novu asks for two default settings for any email provider you connect: -## Sending Email Overrides +* **Sender Name**: The name that will appear in the recipient's "From" field. +* **From Email Address**: The email address the notification will be sent from. For some email providers including SendGrid you will have to authenticate the **From email address** to make sure you're sending an email from an authorized address. -The overrides field supports an email property. The email overrides field have properties like `to`, `from`, `senderName` etc +These are the default values used for every email sent via this integration. You can override them at trigger time if needed. - - -```javascript -import { Novu } from '@novu/api'; +### Provider authentication -const novu = new Novu({ - secretKey: "", - // Use serverURL for EU region - // serverURL: "https://eu.api.novu.co", -}); +You will also need to provide credentials specific to your email provider, such as an API Key, Secret, or Region. Each provider has different requirements. -await novu.trigger({ - workflowId: "workflowId", - to: { - subscriberId: "subscriberId", - }, - overrides: { - email: { - to: ['to@novu.co'], - from: 'from@novu.co', - senderName: 'Novu Team', - text: 'text version of email using overrides', - replyTo: 'no-reply@novu.co', - cc: ['1@novu.co'], - bcc: ['2@novu.co'], - }, - }, -}); -``` - - + See the Supported Providers list at the bottom of this page for detailed setup guides for each integration. - -It's very important to know that Novu merges the `to` field in the email overrides with the subscriber email. It DOES NOT REPLACE IT. - +### Setting up failover -## Sending Email attachments +Novu ensures high deliverability with an automatic failover system. You can have multiple active email providers in the same environment. -You can easily send attachments with the Novu API by passing the attachments array when triggering an Email based workflow. Attachment file can either be in the `buffer` or `base64` format. There is total limit of 20 mb for all attachments included and email size. +* Primary integration: You must designate one of your active providers as the primary provider. Novu will always attempt to send the email using this provider first. +* Failover logic: If the Primary provider fails to send the notification (e.g., its API is down or it returns an error), Novu will automatically retry sending the email through one of your other Active providers. + +This built-in redundancy means you don't have to manage provider downtime yourself. + +## Advanced email features + +You can control advanced email features at runtime by passing data in your trigger call. This lets you send attachments, override default settings, or even target a specific provider for a single notification. + +### Sending attachments + +You can send attachments by passing an `attachments` array in the `payload` of your trigger. The attachment file can be provided as a `buffer` or a `base64` encoded string. + +There is a total limit of 20MB for all attachments included in an email. @@ -93,7 +111,7 @@ await novu.trigger({ to: { subscriberId: "subscriberId", }, - payload: { + payload: { // [!code ++:16] attachments: [ { // buffer format @@ -147,18 +165,49 @@ curl -L -X POST 'https://api.novu.co/v1/events/trigger' \ -## Using different email integration +### Sending email overrides -In Novu integration store, multiple email channel type provider integrations can be active at the same time. But only one provider integration can be primary at a time. This primary integration will be used as a provider to deliver the email by default. If you want to use a different active provider integration then you can use the `integrationIdentifier` email overrides field. +You can override the email settings for a single trigger by passing an `overrides` object. This lets you change the `to` address, `senderName`, `from` address, and more. -If there are 4 active email integrations with these identifiers: + + +```javascript +import { Novu } from '@novu/api'; -1. sendgrid-abcdef -2. sendgrid-ghijkl -3. brevo-abcdef -4. mailersend-abcdef +const novu = new Novu({ + secretKey: "", + // Use serverURL for EU region + // serverURL: "https://eu.api.novu.co", +}); -Here, if `sendgrid-abcdef` is primary integration and you want to use `brevo-abcdef` with this trigger then you can use `integrationIdentifier` email overrides field as below: +await novu.trigger({ + workflowId: "workflowId", + to: { + subscriberId: "subscriberId", + }, + overrides: { // [!code ++:11] + email: { + to: ['to@novu.co'], + from: 'from@novu.co', + senderName: 'Novu Team', + text: 'text version of email using overrides', + replyTo: 'no-reply@novu.co', + cc: ['1@novu.co'], + bcc: ['2@novu.co'], + }, + }, +}); +``` + + + +It's very important to know that Novu merges the `to` field in the email overrides with the subscriber email. It does not replace it. + +### Targeting a specific provider + +By default, Novu uses your primary email provider. However, if you want to bypass this and force a specific, active integration for a trigger, use the `integrationIdentifier`. + +This is useful if you have multiple active integrations for different purposes (for example, one for transactional emails and one for marketing emails). You can find the `integrationIdentifier` in the integration store page. @@ -178,7 +227,7 @@ await novu.trigger({ }, overrides: { email: { - integrationIdentifier: "brevo-abcdef" + integrationIdentifier: "brevo-abcdef" // [!code ++] }, }, }); @@ -186,10 +235,28 @@ await novu.trigger({ - -Integration identifier is similar to Provider identifier but it is different than Provider Id. It is unique for each integration. You can find the `integrationIdentifier` in the integration store page. - - - -Looking to integrate an email provider? Check out our [provider integrations](/platform/integrations/email). - +## Supported providers + +Here are the email providers that are currently supported by Novu. Select any provider to see its detailed setup guide. + + + Learn how to use the SendGrid provider to send emails using Novu. + Learn how to use the Amazon SES provider to send emails using Novu. + Learn how to use the Postmark provider to send emails using Novu. + Learn how to use the Resend provider to send emails using Novu. + Learn how to use the Brevo provider to send emails using Novu. + Learn how to use the Mailgun provider to send emails using Novu. + Learn how to use the Mailjet provider to send emails using Novu. + Learn how to use the Braze provider to send emails using Novu. + Learn how to use the Infobip provider to send emails using Novu. + Learn how to use the MailerSend provider to send emails using Novu. + Learn how to use the Mailtrap provider to send emails using Novu. + Learn how to use the Mandrill provider to send emails using Novu. + Learn how to use the Maqsam provider to send emails using Novu. + Learn how to use the Netcore provider to send emails using Novu. + Learn how to use the Outlook 365 provider to send emails using Novu. + Learn how to use the Plunk provider to send emails using Novu. + Learn how to use the Sparkpost provider to send emails using Novu. + Learn how to use the Email Webhook provider to send emails using Novu. + Learn how to use a Custom SMTP provider to send emails using Novu. + \ No newline at end of file diff --git a/content/docs/platform/integrations/email/meta.json b/content/docs/platform/integrations/email/meta.json index e64cf9a5e..37367e0a6 100644 --- a/content/docs/platform/integrations/email/meta.json +++ b/content/docs/platform/integrations/email/meta.json @@ -1,4 +1,4 @@ { "icon": "Mail", - "pages": ["adding-email", "writing-email-template", "...", "activity-tracking"] + "pages": ["(providers)", "activity-tracking"] } From 82108ef99e0e94e8db5354a63cdb0e6e50394ba3 Mon Sep 17 00:00:00 2001 From: Victor Yakubu <57350321+Aviatorscode2@users.noreply.github.com> Date: Wed, 5 Nov 2025 09:36:45 +0100 Subject: [PATCH 02/25] Update content/docs/platform/integrations/email/index.mdx Co-authored-by: DianaHackmamba --- content/docs/platform/integrations/email/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/platform/integrations/email/index.mdx b/content/docs/platform/integrations/email/index.mdx index ce03bb26d..cfd7f941a 100644 --- a/content/docs/platform/integrations/email/index.mdx +++ b/content/docs/platform/integrations/email/index.mdx @@ -16,7 +16,7 @@ Novu provides a unified integration layer that connects your workflows to these - **Failover mechanisms**: Automatically retry with a backup provider to ensure reliability - **Activity tracking**: Track delivery status, open rates, and more in the Novu dashboard -## How Email works in Novu +## How email works in Novu Here’s the typical flow for sending an email notification through Novu: From f343254c030b7090dd7c68a0e9cd6391eafdb46c Mon Sep 17 00:00:00 2001 From: Victor Yakubu <57350321+Aviatorscode2@users.noreply.github.com> Date: Wed, 5 Nov 2025 09:36:56 +0100 Subject: [PATCH 03/25] Update content/docs/platform/integrations/email/index.mdx Co-authored-by: DianaHackmamba --- content/docs/platform/integrations/email/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/platform/integrations/email/index.mdx b/content/docs/platform/integrations/email/index.mdx index cfd7f941a..281d63fbd 100644 --- a/content/docs/platform/integrations/email/index.mdx +++ b/content/docs/platform/integrations/email/index.mdx @@ -87,7 +87,7 @@ This built-in redundancy means you don't have to manage provider downtime yourse ## Advanced email features -You can control advanced email features at runtime by passing data in your trigger call. This lets you send attachments, override default settings, or even target a specific provider for a single notification. +You can control advanced email features at runtime by passing data in your trigger call. This lets you send attachments, override default settings, or target a specific provider for a single notification. ### Sending attachments From df594425450ef5e5169ad9b82bb02d7e93a573af Mon Sep 17 00:00:00 2001 From: Victor Yakubu <57350321+Aviatorscode2@users.noreply.github.com> Date: Wed, 5 Nov 2025 09:37:05 +0100 Subject: [PATCH 04/25] Update content/docs/platform/integrations/email/index.mdx Co-authored-by: DianaHackmamba --- content/docs/platform/integrations/email/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/platform/integrations/email/index.mdx b/content/docs/platform/integrations/email/index.mdx index 281d63fbd..9bb412bec 100644 --- a/content/docs/platform/integrations/email/index.mdx +++ b/content/docs/platform/integrations/email/index.mdx @@ -201,7 +201,7 @@ await novu.trigger({ -It's very important to know that Novu merges the `to` field in the email overrides with the subscriber email. It does not replace it. +It's very important to know that Novu merges the `to` field in the email overrides with the subscriber email. It does _not_ replace it. ### Targeting a specific provider From a30db20e94f303612d15c591d76f36360f8f1514 Mon Sep 17 00:00:00 2001 From: Victor Yakubu <57350321+Aviatorscode2@users.noreply.github.com> Date: Wed, 5 Nov 2025 09:37:22 +0100 Subject: [PATCH 05/25] Update content/docs/platform/integrations/email/index.mdx Co-authored-by: DianaHackmamba --- content/docs/platform/integrations/email/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/platform/integrations/email/index.mdx b/content/docs/platform/integrations/email/index.mdx index 9bb412bec..6dcd574e1 100644 --- a/content/docs/platform/integrations/email/index.mdx +++ b/content/docs/platform/integrations/email/index.mdx @@ -66,7 +66,7 @@ When you add an email provider in the **Integration Store**, you'll configure se Novu asks for two default settings for any email provider you connect: * **Sender Name**: The name that will appear in the recipient's "From" field. -* **From Email Address**: The email address the notification will be sent from. For some email providers including SendGrid you will have to authenticate the **From email address** to make sure you're sending an email from an authorized address. +* **From Email Address**: The email address the notification will be sent from. For some email providers, including SendGrid, you must authenticate the **From email address** to make sure you're sending an email from an authorized address. These are the default values used for every email sent via this integration. You can override them at trigger time if needed. From fbff40984043f50cd38f300e480b61d329493b63 Mon Sep 17 00:00:00 2001 From: Victor Yakubu <57350321+Aviatorscode2@users.noreply.github.com> Date: Wed, 5 Nov 2025 09:37:51 +0100 Subject: [PATCH 06/25] Update content/docs/platform/integrations/email/index.mdx Co-authored-by: DianaHackmamba --- content/docs/platform/integrations/email/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/platform/integrations/email/index.mdx b/content/docs/platform/integrations/email/index.mdx index 6dcd574e1..24c170186 100644 --- a/content/docs/platform/integrations/email/index.mdx +++ b/content/docs/platform/integrations/email/index.mdx @@ -72,7 +72,7 @@ These are the default values used for every email sent via this integration. You ### Provider authentication -You will also need to provide credentials specific to your email provider, such as an API Key, Secret, or Region. Each provider has different requirements. +You must provide credentials specific to your email provider, such as an API Key, Secret, or Region. Each provider has different requirements. See the Supported Providers list at the bottom of this page for detailed setup guides for each integration. From 60c624a7f08169b42c22b5e6e77ccee9424d4fcf Mon Sep 17 00:00:00 2001 From: Aviatorscode2 Date: Wed, 5 Nov 2025 13:45:11 +0100 Subject: [PATCH 07/25] Update based on feedback --- .../platform/integrations/email/index.mdx | 20 ++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/content/docs/platform/integrations/email/index.mdx b/content/docs/platform/integrations/email/index.mdx index 24c170186..d9ae1ca8c 100644 --- a/content/docs/platform/integrations/email/index.mdx +++ b/content/docs/platform/integrations/email/index.mdx @@ -8,7 +8,7 @@ import { Step, Steps } from 'fumadocs-ui/components/steps'; Email providers are the services that deliver notifications to your subscribers’ email. Each provider must be set up individually in the Novu dashboard to enable delivery through the Email channel. -Novu provides a unified integration layer that connects your workflows to these email providers. Once you’ve added your integrations, Novu handles routing and delivery automatically, sending each email through the correct provider without requiring additional setup. This makes it easy to manage multiple email integrations, and switch providers when needed. +Novu provides a unified integration layer that connects your workflows to these email providers. Once you’ve added your integrations, Novu handles routing and delivery automatically, sending each email through the correct provider without requiring additional setup. This makes it possible to manage multiple email integrations, and switch providers when needed. ## Key features @@ -39,19 +39,21 @@ Next, include an Email step in a workflow. This step defines when and how an ema ### Define the email content -Within the Email step, you can design your message using the built-in visual editor or code editor (for custom HTML and templating with LiquidJS). -Novu supports dynamic data from your payload, so each message can be personalized for the subscriber. +Within the Email step, you can design your message using the built-in visual editor or code editor. Novu supports dynamic data from your payload, so each message can be personalized for the subscriber. ### Store subscriber email addresses -Novu automatically sends the notification to the email address stored on the . You must ensure this field is set for any subscriber who needs to receive emails. You can store or update this using the Novu dashboard, SDK or API. +Novu automatically sends the notification to the email address stored on the . You must ensure this field is set for any subscriber who needs to receive emails. You can store or subscribers’ email address using the Novu dashboard or API. ### Trigger the workflow -Finally, trigger the workflow from your application code by sending an event to Novu. -Novu automatically resolves the subscriber, selects the correct provider, renders the email template, and delivers the message through the configured email integration. +[Trigger the workflow](/api-reference/events/trigger-event) from your application code by sending an event to Novu. Novu automatically: +- Resolves the subscriber. +- Selects the correct provider. +- Renders the email template. +- Delivers the message through the configured email integration. @@ -74,14 +76,14 @@ These are the default values used for every email sent via this integration. You You must provide credentials specific to your email provider, such as an API Key, Secret, or Region. Each provider has different requirements. - See the Supported Providers list at the bottom of this page for detailed setup guides for each integration. + Refer to the [Supported Providers](/platform/integrations/email#supported-providers) list at the bottom of this page for detailed setup guides for each integration. ### Setting up failover Novu ensures high deliverability with an automatic failover system. You can have multiple active email providers in the same environment. * Primary integration: You must designate one of your active providers as the primary provider. Novu will always attempt to send the email using this provider first. -* Failover logic: If the Primary provider fails to send the notification (e.g., its API is down or it returns an error), Novu will automatically retry sending the email through one of your other Active providers. +* Failover logic: If the primary provider fails to send the notification, then Novu will automatically retries sending the email through one of your other active providers. This built-in redundancy means you don't have to manage provider downtime yourself. @@ -207,7 +209,7 @@ await novu.trigger({ By default, Novu uses your primary email provider. However, if you want to bypass this and force a specific, active integration for a trigger, use the `integrationIdentifier`. -This is useful if you have multiple active integrations for different purposes (for example, one for transactional emails and one for marketing emails). You can find the `integrationIdentifier` in the integration store page. +This is useful if you have multiple active integrations for different purposes. For example, you might have one integration for transactional emails and one for marketing emails. You can find the `integrationIdentifier` in the **Integration Store** page. From 794c0a8211991cb7dd7407897389236a6b02e4fb Mon Sep 17 00:00:00 2001 From: Victor Yakubu <57350321+Aviatorscode2@users.noreply.github.com> Date: Wed, 5 Nov 2025 13:48:16 +0100 Subject: [PATCH 08/25] Update content/docs/platform/integrations/email/index.mdx Co-authored-by: DianaHackmamba --- content/docs/platform/integrations/email/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/platform/integrations/email/index.mdx b/content/docs/platform/integrations/email/index.mdx index d9ae1ca8c..6edd516c6 100644 --- a/content/docs/platform/integrations/email/index.mdx +++ b/content/docs/platform/integrations/email/index.mdx @@ -82,7 +82,7 @@ You must provide credentials specific to your email provider, such as an API Key Novu ensures high deliverability with an automatic failover system. You can have multiple active email providers in the same environment. -* Primary integration: You must designate one of your active providers as the primary provider. Novu will always attempt to send the email using this provider first. +* Primary integration: You must designate one of your active providers as the primary provider. Novu always attempts to send the email using this provider first. * Failover logic: If the primary provider fails to send the notification, then Novu will automatically retries sending the email through one of your other active providers. This built-in redundancy means you don't have to manage provider downtime yourself. From 109c6d4af600202be5e05b853a78794e1acf7203 Mon Sep 17 00:00:00 2001 From: Aviatorscode2 Date: Wed, 5 Nov 2025 13:52:25 +0100 Subject: [PATCH 09/25] Add link --- content/docs/platform/integrations/email/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/platform/integrations/email/index.mdx b/content/docs/platform/integrations/email/index.mdx index d9ae1ca8c..1fdb86525 100644 --- a/content/docs/platform/integrations/email/index.mdx +++ b/content/docs/platform/integrations/email/index.mdx @@ -28,7 +28,7 @@ Here’s the typical flow for sending an email notification through Novu: Start by adding an email provider in the **Integration Store** on your Novu dashboard. You can connect one or more integrations for the different or the same providers. -To learn how to add an email provider, refer to the guide for the supported providers. +To learn [how to add an email provider](/platform/integrations/email#supported-providers), refer to the guide for the supported providers. From e79e8fcd0e6d2e2d5ffb63bcbd6e4a5907e70551 Mon Sep 17 00:00:00 2001 From: Victor Yakubu <57350321+Aviatorscode2@users.noreply.github.com> Date: Wed, 5 Nov 2025 23:29:13 +0100 Subject: [PATCH 10/25] Update content/docs/platform/integrations/email/index.mdx Co-authored-by: DianaHackmamba --- content/docs/platform/integrations/email/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/platform/integrations/email/index.mdx b/content/docs/platform/integrations/email/index.mdx index 77772c403..897608584 100644 --- a/content/docs/platform/integrations/email/index.mdx +++ b/content/docs/platform/integrations/email/index.mdx @@ -8,7 +8,7 @@ import { Step, Steps } from 'fumadocs-ui/components/steps'; Email providers are the services that deliver notifications to your subscribers’ email. Each provider must be set up individually in the Novu dashboard to enable delivery through the Email channel. -Novu provides a unified integration layer that connects your workflows to these email providers. Once you’ve added your integrations, Novu handles routing and delivery automatically, sending each email through the correct provider without requiring additional setup. This makes it possible to manage multiple email integrations, and switch providers when needed. +Novu provides a unified integration layer that connects your workflows to these email providers. Once you’ve added your integrations, Novu handles routing and delivery automatically, sending each email through the correct provider without requiring additional setup. This allows you to manage multiple email integrations and switch providers when needed. ## Key features From cae17e4c3bba89b49248f7682d08bcb6a05b2b2c Mon Sep 17 00:00:00 2001 From: Victor Yakubu <57350321+Aviatorscode2@users.noreply.github.com> Date: Wed, 5 Nov 2025 23:45:00 +0100 Subject: [PATCH 11/25] Update content/docs/platform/integrations/email/index.mdx Co-authored-by: DianaHackmamba --- content/docs/platform/integrations/email/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/platform/integrations/email/index.mdx b/content/docs/platform/integrations/email/index.mdx index 897608584..998948590 100644 --- a/content/docs/platform/integrations/email/index.mdx +++ b/content/docs/platform/integrations/email/index.mdx @@ -82,7 +82,7 @@ You must provide credentials specific to your email provider, such as an API Key Novu ensures high deliverability with an automatic failover system. You can have multiple active email providers in the same environment. -* Primary integration: You must designate one of your active providers as the primary provider. Novu always attempts to send the email using this provider first. +- Primary integration: You must designate one of your active providers as the primary provider. Novu always attempts to send the email using this provider first. * Failover logic: If the primary provider fails to send the notification, then Novu will automatically retries sending the email through one of your other active providers. This built-in redundancy means you don't have to manage provider downtime yourself. From 5ffe0946117e1bf655d9a9d2f8c1952d048bc779 Mon Sep 17 00:00:00 2001 From: Victor Yakubu <57350321+Aviatorscode2@users.noreply.github.com> Date: Wed, 5 Nov 2025 23:45:15 +0100 Subject: [PATCH 12/25] Update content/docs/platform/integrations/email/index.mdx Co-authored-by: DianaHackmamba --- content/docs/platform/integrations/email/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/platform/integrations/email/index.mdx b/content/docs/platform/integrations/email/index.mdx index 998948590..6207f29b0 100644 --- a/content/docs/platform/integrations/email/index.mdx +++ b/content/docs/platform/integrations/email/index.mdx @@ -26,7 +26,7 @@ Here’s the typical flow for sending an email notification through Novu: ### Add an email provider -Start by adding an email provider in the **Integration Store** on your Novu dashboard. You can connect one or more integrations for the different or the same providers. +Start by adding an email provider in the **Integration Store** on your Novu dashboard. You can connect one or more integrations for different or the same providers. To learn [how to add an email provider](/platform/integrations/email#supported-providers), refer to the guide for the supported providers. From f02b7748612ed2e720e491f81da48112d476238d Mon Sep 17 00:00:00 2001 From: Victor Yakubu <57350321+Aviatorscode2@users.noreply.github.com> Date: Wed, 5 Nov 2025 23:45:27 +0100 Subject: [PATCH 13/25] Update content/docs/platform/integrations/email/index.mdx Co-authored-by: DianaHackmamba --- content/docs/platform/integrations/email/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/platform/integrations/email/index.mdx b/content/docs/platform/integrations/email/index.mdx index 6207f29b0..c3a91f8d4 100644 --- a/content/docs/platform/integrations/email/index.mdx +++ b/content/docs/platform/integrations/email/index.mdx @@ -203,7 +203,7 @@ await novu.trigger({ -It's very important to know that Novu merges the `to` field in the email overrides with the subscriber email. It does _not_ replace it. +Note that Novu merges the `to` field in the email overrides with the subscriber email. It does _not_ replace it. ### Targeting a specific provider From 8a42ca5f96155e506f49c70f014f4022b489253d Mon Sep 17 00:00:00 2001 From: Victor Yakubu <57350321+Aviatorscode2@users.noreply.github.com> Date: Wed, 5 Nov 2025 23:47:18 +0100 Subject: [PATCH 14/25] Update content/docs/platform/integrations/email/index.mdx Co-authored-by: DianaHackmamba --- content/docs/platform/integrations/email/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/platform/integrations/email/index.mdx b/content/docs/platform/integrations/email/index.mdx index c3a91f8d4..fd06e6f03 100644 --- a/content/docs/platform/integrations/email/index.mdx +++ b/content/docs/platform/integrations/email/index.mdx @@ -83,7 +83,7 @@ You must provide credentials specific to your email provider, such as an API Key Novu ensures high deliverability with an automatic failover system. You can have multiple active email providers in the same environment. - Primary integration: You must designate one of your active providers as the primary provider. Novu always attempts to send the email using this provider first. -* Failover logic: If the primary provider fails to send the notification, then Novu will automatically retries sending the email through one of your other active providers. +- Failover logic: If the primary provider fails to send the notification, then Novu automatically attempts to send the email through one of your other active providers. This built-in redundancy means you don't have to manage provider downtime yourself. From 20db3513a712f25a137f5f9e0267a3093aa8355f Mon Sep 17 00:00:00 2001 From: Victor Yakubu <57350321+Aviatorscode2@users.noreply.github.com> Date: Wed, 5 Nov 2025 23:47:28 +0100 Subject: [PATCH 15/25] Update content/docs/platform/integrations/email/index.mdx Co-authored-by: DianaHackmamba --- content/docs/platform/integrations/email/index.mdx | 1 - 1 file changed, 1 deletion(-) diff --git a/content/docs/platform/integrations/email/index.mdx b/content/docs/platform/integrations/email/index.mdx index fd06e6f03..26bea2cf6 100644 --- a/content/docs/platform/integrations/email/index.mdx +++ b/content/docs/platform/integrations/email/index.mdx @@ -21,7 +21,6 @@ Novu provides a unified integration layer that connects your workflows to these Here’s the typical flow for sending an email notification through Novu: - ### Add an email provider From 482f7f506179a6c0562edadac1fa53a652dea0e1 Mon Sep 17 00:00:00 2001 From: Victor Yakubu <57350321+Aviatorscode2@users.noreply.github.com> Date: Wed, 5 Nov 2025 23:47:40 +0100 Subject: [PATCH 16/25] Update content/docs/platform/integrations/email/index.mdx Co-authored-by: DianaHackmamba --- content/docs/platform/integrations/email/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/platform/integrations/email/index.mdx b/content/docs/platform/integrations/email/index.mdx index 26bea2cf6..aa3b27655 100644 --- a/content/docs/platform/integrations/email/index.mdx +++ b/content/docs/platform/integrations/email/index.mdx @@ -27,7 +27,7 @@ Here’s the typical flow for sending an email notification through Novu: Start by adding an email provider in the **Integration Store** on your Novu dashboard. You can connect one or more integrations for different or the same providers. -To learn [how to add an email provider](/platform/integrations/email#supported-providers), refer to the guide for the supported providers. +To learn how to add an email provider, refer to the guide for the [supported providers](/platform/integrations/email#supported-providers). From 12400ffad2e5fcce918ab8d5b2ad96a8ba47c426 Mon Sep 17 00:00:00 2001 From: Victor Yakubu <57350321+Aviatorscode2@users.noreply.github.com> Date: Wed, 5 Nov 2025 23:47:56 +0100 Subject: [PATCH 17/25] Update content/docs/platform/integrations/email/index.mdx Co-authored-by: DianaHackmamba --- content/docs/platform/integrations/email/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/platform/integrations/email/index.mdx b/content/docs/platform/integrations/email/index.mdx index aa3b27655..458314198 100644 --- a/content/docs/platform/integrations/email/index.mdx +++ b/content/docs/platform/integrations/email/index.mdx @@ -66,7 +66,7 @@ When you add an email provider in the **Integration Store**, you'll configure se Novu asks for two default settings for any email provider you connect: -* **Sender Name**: The name that will appear in the recipient's "From" field. +- **Sender Name**: The name that appears in the recipient's "From" field. * **From Email Address**: The email address the notification will be sent from. For some email providers, including SendGrid, you must authenticate the **From email address** to make sure you're sending an email from an authorized address. These are the default values used for every email sent via this integration. You can override them at trigger time if needed. From 7e4ddc18c752b6b79fff03d3622ae9711ce04ee9 Mon Sep 17 00:00:00 2001 From: Victor Yakubu <57350321+Aviatorscode2@users.noreply.github.com> Date: Wed, 5 Nov 2025 23:48:09 +0100 Subject: [PATCH 18/25] Update content/docs/platform/integrations/email/index.mdx Co-authored-by: DianaHackmamba --- content/docs/platform/integrations/email/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/platform/integrations/email/index.mdx b/content/docs/platform/integrations/email/index.mdx index 458314198..3fbf11d34 100644 --- a/content/docs/platform/integrations/email/index.mdx +++ b/content/docs/platform/integrations/email/index.mdx @@ -67,7 +67,7 @@ When you add an email provider in the **Integration Store**, you'll configure se Novu asks for two default settings for any email provider you connect: - **Sender Name**: The name that appears in the recipient's "From" field. -* **From Email Address**: The email address the notification will be sent from. For some email providers, including SendGrid, you must authenticate the **From email address** to make sure you're sending an email from an authorized address. +- **From Email Address**: The email address the notification will be sent from. For some email providers, including SendGrid, you must authenticate the **From email address** to make sure you're sending an email from an authorized address. These are the default values used for every email sent via this integration. You can override them at trigger time if needed. From 8e1a02c42add8cdb7a1291f6f14841f8ec242fca Mon Sep 17 00:00:00 2001 From: Victor Yakubu <57350321+Aviatorscode2@users.noreply.github.com> Date: Thu, 6 Nov 2025 10:47:12 +0100 Subject: [PATCH 19/25] Update content/docs/platform/integrations/email/index.mdx Co-authored-by: DianaHackmamba --- content/docs/platform/integrations/email/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/platform/integrations/email/index.mdx b/content/docs/platform/integrations/email/index.mdx index 3fbf11d34..180ff48ce 100644 --- a/content/docs/platform/integrations/email/index.mdx +++ b/content/docs/platform/integrations/email/index.mdx @@ -6,7 +6,7 @@ description: 'Learn how to configure the Email channel' import { Step, Steps } from 'fumadocs-ui/components/steps'; -Email providers are the services that deliver notifications to your subscribers’ email. Each provider must be set up individually in the Novu dashboard to enable delivery through the Email channel. +Email providers are the services that deliver notifications to your subscribers’ email. You must set up each provider individually in the Novu dashboard to enable delivery through the Email channel. Novu provides a unified integration layer that connects your workflows to these email providers. Once you’ve added your integrations, Novu handles routing and delivery automatically, sending each email through the correct provider without requiring additional setup. This allows you to manage multiple email integrations and switch providers when needed. From 5726e1676e1713413d019a8b97742129687fa15d Mon Sep 17 00:00:00 2001 From: Aviatorscode2 Date: Thu, 6 Nov 2025 12:46:04 +0100 Subject: [PATCH 20/25] Update contet --- .../platform/integrations/email/index.mdx | 27 ++++++++++++------- 1 file changed, 17 insertions(+), 10 deletions(-) diff --git a/content/docs/platform/integrations/email/index.mdx b/content/docs/platform/integrations/email/index.mdx index 180ff48ce..3e4128ffd 100644 --- a/content/docs/platform/integrations/email/index.mdx +++ b/content/docs/platform/integrations/email/index.mdx @@ -12,9 +12,9 @@ Novu provides a unified integration layer that connects your workflows to these ## Key features -- **Multi-provider support**: Integrate any major provider like SendGrid, SES, or Mailgun -- **Failover mechanisms**: Automatically retry with a backup provider to ensure reliability -- **Activity tracking**: Track delivery status, open rates, and more in the Novu dashboard +- **Multi-provider support**: Integrate any major provider like SendGrid, SES, or Mailgun. +- **Failover mechanisms**: Automatically retry with a backup provider to ensure reliability. +- **Activity tracking**: Track delivery status, open rates, and more in the Novu dashboard. ## How email works in Novu @@ -43,7 +43,7 @@ Within the Email step, you can design your message using the built-in visual edi ### Store subscriber email addresses -Novu automatically sends the notification to the email address stored on the . You must ensure this field is set for any subscriber who needs to receive emails. You can store or subscribers’ email address using the Novu dashboard or API. +Novu automatically sends the notification to the email address stored on the . You must ensure this field is set for any subscriber who needs to receive emails. You can store email address in each subscribers’ profile using the Novu dashboard or API. ### Trigger the workflow @@ -56,7 +56,7 @@ Novu automatically sends the notification to the email address stored on the . Y - Looking to build your email template? Learn how to use the block editor, custom HTML, and dynamic variables in our guide. +Learn how to [build email template](/platform/workflow/template-editor) using the block editor, custom HTML, and dynamic variables. ## Configuring email providers @@ -69,13 +69,13 @@ Novu asks for two default settings for any email provider you connect: - **Sender Name**: The name that appears in the recipient's "From" field. - **From Email Address**: The email address the notification will be sent from. For some email providers, including SendGrid, you must authenticate the **From email address** to make sure you're sending an email from an authorized address. -These are the default values used for every email sent via this integration. You can override them at trigger time if needed. +These are the default values used for every email sent via this integration. You can override them when triggering a workflow if needed. ### Provider authentication -You must provide credentials specific to your email provider, such as an API Key, Secret, or Region. Each provider has different requirements. +You must provide credentials specific to your email provider for a successful integration. - Refer to the [Supported Providers](/platform/integrations/email#supported-providers) list at the bottom of this page for detailed setup guides for each integration. +For detailed setup guides for each integration, refer to the [Supported Providers](/platform/integrations/email#supported-providers) list at the bottom of this page. ### Setting up failover @@ -168,7 +168,14 @@ curl -L -X POST 'https://api.novu.co/v1/events/trigger' \ ### Sending email overrides -You can override the email settings for a single trigger by passing an `overrides` object. This lets you change the `to` address, `senderName`, `from` address, and more. +You can override the email settings for a single trigger by passing an `overrides` object. This lets you override the following fields: +- `to` address, +- `senderName` +- `from` address +- `text` +- `replyTo` +- `cc` +- `bcc` @@ -208,7 +215,7 @@ await novu.trigger({ By default, Novu uses your primary email provider. However, if you want to bypass this and force a specific, active integration for a trigger, use the `integrationIdentifier`. -This is useful if you have multiple active integrations for different purposes. For example, you might have one integration for transactional emails and one for marketing emails. You can find the `integrationIdentifier` in the **Integration Store** page. +This is useful if you have multiple active integrations for different purposes. For example, you might have one integration for transactional emails and one for marketing emails. You can find the `integrationIdentifier` for each provider in provider page in the **Integration Store**. From cc453ecfadf3a298cdb9203f2e170917b7243f5a Mon Sep 17 00:00:00 2001 From: Victor Yakubu <57350321+Aviatorscode2@users.noreply.github.com> Date: Sat, 15 Nov 2025 21:12:21 +0100 Subject: [PATCH 21/25] Update content/docs/platform/integrations/email/index.mdx Co-authored-by: DianaHackmamba --- content/docs/platform/integrations/email/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/platform/integrations/email/index.mdx b/content/docs/platform/integrations/email/index.mdx index 3e4128ffd..6f82cea1e 100644 --- a/content/docs/platform/integrations/email/index.mdx +++ b/content/docs/platform/integrations/email/index.mdx @@ -60,7 +60,7 @@ Novu automatically sends the notification to the email address stored on the . Y ## Configuring email providers -When you add an email provider in the **Integration Store**, you'll configure settings that are common to all email providers, as well as credentials specific to that provider. +When you add an email provider in the **Integration Store**, you configure settings that are common to all email providers, as well as credentials specific to that provider. ### Default sender settings From edf0945ad7af99c64992cdf9b702c49b0433010c Mon Sep 17 00:00:00 2001 From: Victor Yakubu <57350321+Aviatorscode2@users.noreply.github.com> Date: Sat, 15 Nov 2025 21:12:33 +0100 Subject: [PATCH 22/25] Update content/docs/platform/integrations/email/index.mdx Co-authored-by: DianaHackmamba --- content/docs/platform/integrations/email/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/platform/integrations/email/index.mdx b/content/docs/platform/integrations/email/index.mdx index 6f82cea1e..8b3e649bb 100644 --- a/content/docs/platform/integrations/email/index.mdx +++ b/content/docs/platform/integrations/email/index.mdx @@ -81,7 +81,7 @@ You must provide credentials specific to your email provider for a successful in Novu ensures high deliverability with an automatic failover system. You can have multiple active email providers in the same environment. -- Primary integration: You must designate one of your active providers as the primary provider. Novu always attempts to send the email using this provider first. +- **Primary integration**: You must designate one of your active providers as the primary provider. Novu always attempts to send the email using this provider first. - Failover logic: If the primary provider fails to send the notification, then Novu automatically attempts to send the email through one of your other active providers. This built-in redundancy means you don't have to manage provider downtime yourself. From 2200d266b7177919e721241536d41f7b3e58fb60 Mon Sep 17 00:00:00 2001 From: Victor Yakubu <57350321+Aviatorscode2@users.noreply.github.com> Date: Sat, 15 Nov 2025 21:12:44 +0100 Subject: [PATCH 23/25] Update content/docs/platform/integrations/email/index.mdx Co-authored-by: DianaHackmamba --- content/docs/platform/integrations/email/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/platform/integrations/email/index.mdx b/content/docs/platform/integrations/email/index.mdx index 8b3e649bb..bc034de93 100644 --- a/content/docs/platform/integrations/email/index.mdx +++ b/content/docs/platform/integrations/email/index.mdx @@ -82,7 +82,7 @@ You must provide credentials specific to your email provider for a successful in Novu ensures high deliverability with an automatic failover system. You can have multiple active email providers in the same environment. - **Primary integration**: You must designate one of your active providers as the primary provider. Novu always attempts to send the email using this provider first. -- Failover logic: If the primary provider fails to send the notification, then Novu automatically attempts to send the email through one of your other active providers. +- **Failover logic**: If the primary provider fails to send the notification, then Novu automatically attempts to send the email through one of your other active providers. This built-in redundancy means you don't have to manage provider downtime yourself. From 9712a82b24221e61f7ddd7a78c60b3ff55f32ba1 Mon Sep 17 00:00:00 2001 From: Aviatorscode2 Date: Wed, 19 Nov 2025 19:22:01 +0100 Subject: [PATCH 24/25] Update content --- .../platform/integrations/email/index.mdx | 24 +++++++++---------- 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/content/docs/platform/integrations/email/index.mdx b/content/docs/platform/integrations/email/index.mdx index bc034de93..aafaaa7a7 100644 --- a/content/docs/platform/integrations/email/index.mdx +++ b/content/docs/platform/integrations/email/index.mdx @@ -43,16 +43,16 @@ Within the Email step, you can design your message using the built-in visual edi ### Store subscriber email addresses -Novu automatically sends the notification to the email address stored on the . You must ensure this field is set for any subscriber who needs to receive emails. You can store email address in each subscribers’ profile using the Novu dashboard or API. +Novu automatically sends the notification to the email address stored on the subscriber's profile. This profile is update either using the Novu dashboard or API. ### Trigger the workflow [Trigger the workflow](/api-reference/events/trigger-event) from your application code by sending an event to Novu. Novu automatically: -- Resolves the subscriber. -- Selects the correct provider. -- Renders the email template. -- Delivers the message through the configured email integration. +1. Resolves the subscriber. +2. Selects the correct provider. +3. Renders the email template. +4. Delivers the message through the configured email integration. @@ -66,8 +66,8 @@ When you add an email provider in the **Integration Store**, you configure setti Novu asks for two default settings for any email provider you connect: -- **Sender Name**: The name that appears in the recipient's "From" field. -- **From Email Address**: The email address the notification will be sent from. For some email providers, including SendGrid, you must authenticate the **From email address** to make sure you're sending an email from an authorized address. +- **Sender name**: The name that appears in the recipient's "From" field. +- **From email address**: The email address the notification is sent from. For some email providers, including SendGrid, you must authenticate the **From email address** to make sure you're sending an email from an authorized address. These are the default values used for every email sent via this integration. You can override them when triggering a workflow if needed. @@ -169,13 +169,13 @@ curl -L -X POST 'https://api.novu.co/v1/events/trigger' \ ### Sending email overrides You can override the email settings for a single trigger by passing an `overrides` object. This lets you override the following fields: -- `to` address, -- `senderName` +- `bcc` +- `cc` - `from` address -- `text` - `replyTo` -- `cc` -- `bcc` +- `senderName` +- `text` +- `to` address From 43cbe4f030cdd8fa2113f1dfebda5faf48c56773 Mon Sep 17 00:00:00 2001 From: Aviatorscode2 Date: Fri, 21 Nov 2025 10:09:25 +0100 Subject: [PATCH 25/25] Fix email channel capitaliation inconsistencies --- content/docs/platform/integrations/email/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/platform/integrations/email/index.mdx b/content/docs/platform/integrations/email/index.mdx index aafaaa7a7..3a4e2fbdb 100644 --- a/content/docs/platform/integrations/email/index.mdx +++ b/content/docs/platform/integrations/email/index.mdx @@ -31,7 +31,7 @@ To learn how to add an email provider, refer to the guide for the [supported pro -### Add the email channel to your workflow +### Add the Email channel to your workflow Next, include an Email step in a workflow. This step defines when and how an email should be sent as part of your notification workflow.