Docs for Email home page #998
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the ✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
DianaHackmamba
requested changes
Nov 3, 2025
Co-authored-by: DianaHackmamba <diana@hackmamba.io>
Co-authored-by: DianaHackmamba <diana@hackmamba.io>
Co-authored-by: DianaHackmamba <diana@hackmamba.io>
Co-authored-by: DianaHackmamba <diana@hackmamba.io>
Co-authored-by: DianaHackmamba <diana@hackmamba.io>
Co-authored-by: DianaHackmamba <diana@hackmamba.io>
DianaHackmamba
requested changes
Nov 5, 2025
Co-authored-by: DianaHackmamba <diana@hackmamba.io>
Co-authored-by: DianaHackmamba <diana@hackmamba.io>
Co-authored-by: DianaHackmamba <diana@hackmamba.io>
Co-authored-by: DianaHackmamba <diana@hackmamba.io>
Co-authored-by: DianaHackmamba <diana@hackmamba.io>
Co-authored-by: DianaHackmamba <diana@hackmamba.io>
Co-authored-by: DianaHackmamba <diana@hackmamba.io>
Co-authored-by: DianaHackmamba <diana@hackmamba.io>
Co-authored-by: DianaHackmamba <diana@hackmamba.io>
Co-authored-by: DianaHackmamba <diana@hackmamba.io>
DianaHackmamba
requested changes
Nov 10, 2025
| <Step> | ||
| ### 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. |
Contributor
There was a problem hiding this comment.
Suggested change
| 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 ???. 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 | ||
|
|
||
| [Trigger the workflow](/api-reference/events/trigger-event) from your application code by sending an event to Novu. Novu automatically: | ||
| - Resolves the subscriber. |
Contributor
There was a problem hiding this comment.
Should this be a numbered list?
| ## 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. |
Contributor
There was a problem hiding this comment.
Suggested change
| 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. |
|
|
||
| ## Sending Email Overrides | ||
| - **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. |
Contributor
There was a problem hiding this comment.
Suggested change
| - **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 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. |
Contributor
There was a problem hiding this comment.
The capitalization for the two "From Email Address"s don't match.
| 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 always attempts to send the email using this provider first. |
Contributor
There was a problem hiding this comment.
Suggested change
| - 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. |
|
|
||
| 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 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. |
Contributor
There was a problem hiding this comment.
Suggested change
| - 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. |
|
|
||
| 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 override the following fields: | ||
| - `to` address, |
Contributor
There was a problem hiding this comment.
What is the logic behind this list order?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.