Skip to content
Merged
Show file tree
Hide file tree
Changes from 15 commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
335efc0
Content for SMS home page
Aviatorscode2 Oct 30, 2025
42830c8
Update docs
Aviatorscode2 Oct 31, 2025
31bf9b8
Update content based on feedback
Aviatorscode2 Nov 5, 2025
74ebc6a
Update content/docs/platform/integrations/sms/index.mdx
Aviatorscode2 Nov 5, 2025
cc42009
Update content/docs/platform/integrations/sms/index.mdx
Aviatorscode2 Nov 5, 2025
c90a87a
Update content/docs/platform/integrations/sms/index.mdx
Aviatorscode2 Nov 5, 2025
c4ec64f
Update content based on Diana's feedback
Aviatorscode2 Nov 5, 2025
6a36ad6
Merge branch 'MRK-1107-sms' of https://github.com/novuhq/docs into MR…
Aviatorscode2 Nov 5, 2025
674384e
Update content/docs/platform/integrations/sms/index.mdx
Aviatorscode2 Nov 5, 2025
9e0aeeb
Update content/docs/platform/integrations/sms/index.mdx
Aviatorscode2 Nov 5, 2025
ffea374
Update content/docs/platform/integrations/sms/index.mdx
Aviatorscode2 Nov 5, 2025
c83ba09
Update card to be alphabetical
Aviatorscode2 Nov 5, 2025
6e4c009
Merge pull request #999 from novuhq/MRK-1107-sms
Aviatorscode2 Nov 5, 2025
cdd6172
Content for the overview page (#1005)
Aviatorscode2 Nov 12, 2025
9fdf817
Minor update to the Trigger overrides page (#1007)
Aviatorscode2 Nov 19, 2025
6e2d78d
Docs for Email home page (#998)
Aviatorscode2 Nov 21, 2025
698d067
Mrk 1105 (Push page) (#997)
Aviatorscode2 Nov 22, 2025
e0b14c8
Update content for demo integration (#1006)
Aviatorscode2 Nov 25, 2025
0539bc7
Merge branch 'main' of https://github.com/novuhq/docs into channels-p…
Aviatorscode2 Nov 25, 2025
ba40cea
Clean up for the integrate channels providers section (#1014)
Aviatorscode2 Nov 25, 2025
b18671f
Mrk 1108 chat (#1001)
Aviatorscode2 Dec 4, 2025
c9d288f
Merge branch 'main' into channels-providers-integration
jainpawan21 Dec 7, 2025
9e90454
Push provider guides (#1003)
Aviatorscode2 Dec 7, 2025
458257f
Merge branch 'main' into channels-providers-integration
jainpawan21 Dec 7, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 54 additions & 9 deletions content/docs/platform/integrations/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,22 +1,67 @@
---
pageTitle: 'Novu Integration Hub'
title: 'Overview'
description: 'Discover how to integrate Novu with your tech stack including delivery providers, content frameworks, and validation libraries.'
description: 'Learn about the providers that Novu supports for Email, Push, SMS and Chant channels, and how to integrate them to send notifications and receive events.'
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Fix typo in meta description.

"Chant" should be "Chat".

-description: 'Learn about the providers that Novu supports for Email, Push, SMS and Chant channels, and how to integrate them to send notifications and receive events.'
+description: 'Learn about the providers that Novu supports for Email, Push, SMS and Chat channels, and how to integrate them to send notifications and receive events.'
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
description: 'Learn about the providers that Novu supports for Email, Push, SMS and Chant channels, and how to integrate them to send notifications and receive events.'
description: 'Learn about the providers that Novu supports for Email, Push, SMS and Chat channels, and how to integrate them to send notifications and receive events.'
🤖 Prompt for AI Agents
In content/docs/platform/integrations/overview.mdx around line 4, the meta
description contains a typo: the word "Chant" should be "Chat"; update the
description string to replace "Chant" with "Chat" so it reads "...for Email,
Push, SMS and Chat channels..." and save the file.

icon: 'LayoutDashboard'
---

import { Card, Cards } from 'fumadocs-ui/components/card';
Providers are the third-party services that deliver your notifications through the various channels. These are services such as SendGrid for email, Twilio for SMS, or Slack for chat.

Novu was designed to be integrated with any part of your tech stack. This includes:
Novu provides a unified integration layer that connects your application to all these different providers. You connect your provider accounts to Novu from the Integration Store on the Novu dashboard, and Novu's API handles the rest.

- Delivery providers
- Content frameworks
- Validation and schema libraries
- and more!
This approach means you can add, remove, or switch providers at any time without having to change your application's code. It also allows Novu to manage complex logic like provider fallbacks, for example, "If SendGrid fails, try sending with Amazon SES".

## Delivery provider integrations
## Provider vs. Integration

You can find the list of available integrations for each channel:
Understanding the difference between a provider and an integration is key to managing your channels.

- **Provider**: A provider is the third-party service responsible for sending the actual notification such as, Twilio, SendGrid, or Slack. Every provider supported by Novu is identified by a providerId. Refer to this resource to see the full list of provider IDs used in Novu.

- **Integration**: An integration is your specific, configured instance of that provider. It's the provider plus your unique credentials and settings. When creating an integration, you are required to assign it a name and identifier.

While the name can be changged, the identifier cannot be changed after creation. This identifier is called the `integrationIdentifier`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Fix typo: "changged" → "changed".

-  While the name can be changged, the identifier cannot be changed after creation. This identifier is called the `integrationIdentifier`.
+  While the name can be changed, the identifier cannot be changed after creation. This identifier is called the `integrationIdentifier`.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
While the name can be changged, the identifier cannot be changed after creation. This identifier is called the `integrationIdentifier`.
While the name can be changed, the identifier cannot be changed after creation. This identifier is called the `integrationIdentifier`.
🤖 Prompt for AI Agents
In content/docs/platform/integrations/overview.mdx around line 22, fix the typo
"changged" to "changed" in the sentence so it reads: "While the name can be
changed, the identifier cannot be changed after creation. This identifier is
called the `integrationIdentifier`." Replace the misspelled word only,
preserving the rest of the sentence and formatting.


![integrationIdentifier](/images/channels-and-providers/integrationidentifier.png)

This means that you can have provider but two separate integrations for that particular provider. Each of these is a unique integration that you can manage and trigger independently.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Clarify sentence grammar.

The sentence is incomplete. Consider: "you can have one provider but multiple separate integrations for that particular provider" or "you can have the same provider but two separate integrations."

-This means that you can have provider but two separate integrations for that particular provider. Each of these is a unique integration that you can manage and trigger independently.
+This means that you can have one provider but multiple separate integrations for that particular provider. Each of these is a unique integration that you can manage and trigger independently.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
This means that you can have provider but two separate integrations for that particular provider. Each of these is a unique integration that you can manage and trigger independently.
This means that you can have one provider but multiple separate integrations for that particular provider. Each of these is a unique integration that you can manage and trigger independently.
🤖 Prompt for AI Agents
In content/docs/platform/integrations/overview.mdx around line 26, the sentence
"This means that you can have provider but two separate integrations for that
particular provider." is grammatically incorrect and incomplete; update it to a
clear form such as "This means that you can have one provider but multiple
separate integrations for that particular provider." or "This means that you can
have the same provider but two separate integrations for that provider." Replace
the existing sentence with one of these corrected alternatives to fix grammar
and clarity.


<Callout type="info">Novu providers demo integrations. To learn more about how to use them for testing, see the [Demo Integration](/platform/integrations/demo-providers) guide.</Callout>

### Primary vs. Active integrations

Each environment can have multiple active integrations for a single channel.

![Primary and active integration](/images/channels-and-providers/primary-active-integrations.png)

- **Active integration**: Any integration that is "on" and ready to send notifications. You can disable an active integration at any time to stop sending messages through it.
- **Primary integration**: This is the default integration used when you trigger a notification.

How the primary integration behaves depends on the channel:

- **Email and SMS channels**: You can have many active integrations, but only one can be marked as the primary at a time. This primary integration is used by default for all email or SMS notifications unless you specifically override it.

- **Push and chat channels**: These channels do not use a single primary integration. Instead, Novu uses all active integrations in parallel to deliver the message.

If you disable an integration that is currently marked as "primary" for Email or SMS channels, then Novu automatically promotes another active integration to be the new primary. You can also manually set which active integration you want to be the primary one from the Integration Store.

## Managing integrations across environments

Each integration is scoped to a specific [environment](/platform/concepts/environments). This means you must configure separate integrations for each environment, even if they point to the same provider.

This separation ensures that test messages don’t accidentally go to production users, and different credentials or delivery settings can be safely isolated across environments.

## Override default settings

Novu provides an `overrides` object that can be used to access features that Novu doesn't currently support but are supported by certain providers. This feature includes:
- Setting custom SendGrid headers.
- Using Slack blocks.
- Defining platform-specific sounds for FCM push notifications.

<Callout>For a complete guide on Overrides, refer to the [Trigger Overrides](/platform/integrations/trigger-overrides) documentation.</Callout>

## Integration guides

Select a channel below to find the list of all supported providers integrations and their detailed setup guides:

<Cards>
<Card title="Email" href="/platform/integrations/email">
Expand Down
135 changes: 94 additions & 41 deletions content/docs/platform/integrations/sms/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,35 +5,76 @@ description: "Configure and manage SMS notification providers like Twilio, Nexmo
icon: 'circle-info'
---

Novu makes SMS notifications simple, scalable, and reliable, enabling seamless integration with your communication stack. Whether you're sending OTPs, updates, or transactional messages, Novu ensures your SMS notifications are delivered efficiently and effectively.
The SMS channel delivers messages to your subscribers’ mobile devices through your configured SMS provider integrations.

With the SMS channel, you can:
## How SMS delivery works in Novu

- **Switch Providers Effortlessly:** Integrate popular services like Twilio, Nexmo, or a custom provider
- **Deliver at Scale:** Handle high-volume messaging with confidence
- **Customize and Track:** Tailor SMS content dynamically and monitor delivery status in real time
Here’s the typical flow for sending an email notification through Novu:

## Key Features
<Steps>
<Step>

- **Dynamic Messaging:** Inject user-specific data into messages for personalization
- **Multi-Provider Support:** Switch or combine providers to maximize reliability
- **Delivery Insights:** Track message delivery, failures, and user engagement
- **Fallback Mechanisms:** Ensure reliable messaging with backup providers
- **Template Management:** Simplify content creation with reusable SMS templates
- **Streamlined API Integration:** Easily connect your backend for automated messaging workflows
### Add an email provider

## Common Use Cases
Start by adding an SMS provider in the **Integration Store** on your Novu dashboard. You can connect one or more integrations for the different or the same providers.

- **Transactional Notifications:** Send OTPs, receipts, or order updates instantly
- **Marketing Campaigns:** Deliver promotional offers and updates to your audience
- **Critical Alerts:** Notify users of urgent events, like security breaches or system outages
- **Reminders and Scheduling:** Automate reminders for appointments, events, or deadlines
To learn [how to add an SMS provider](/platform/integrations/sms#supported-providers), refer to the guide for that provider.

</Step>
<Step>
### Add the email channel to your workflow

Next, include an [SMS step in your workflow](/platform/workflow/build-a-workflow). This step defines when and how an SMS should be sent as part of your notification workflow.
</Step>
<Step>
### Define the SMS content

## Sending SMS overrides
Within the Email step editor, write the message body. The editor supports dynamic data for personalized content.

The overrides field supports a `sms` property and `from`, `to`, `content` field overrides. This allows you to send a message to a different recipient, from a different sender, or with a different content.
</Step>
<Step>
### Store subscriber phone number

Novu automatically sends the notification to the phone number stored on the subscriber's profile . You must ensure that this field is set for any subscriber who needs to receive emails. You can store subscribers phone number using the Novu API, or SDK.
</Step>
<Step>
### 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.
</Step>
</Steps>
Comment on lines +8 to +50
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🔴 Critical

Fix systematic copy-paste errors: "email" should be "SMS" throughout the workflow steps.

The step-by-step workflow structure is excellent, but multiple instances incorrectly reference "email" instead of "SMS." These appear to be copy-paste errors from email integration documentation:

  • Line 12: "sending an email notification" → should be "SMS notification"
  • Line 17: "Add an email provider" → should be "SMS provider"
  • Line 25: "Add the email channel" → should be "SMS channel"
  • Line 32: "Within the Email step editor" → should be "SMS step editor"
  • Line 38: "receive emails" → should be "receive SMS"
  • Line 47: "Renders the email template" → should be "SMS template"
  • Line 48: "through the configured email integration" → should be "SMS integration"

Apply this diff to correct all references:

-Here's the typical flow for sending an email notification through Novu:
+Here's the typical flow for sending an SMS notification through Novu:

-### Add an email provider
+### Add an SMS provider

-### Add the email channel to your workflow
+### Add the SMS channel to your workflow

-Within the Email step editor, write the message body.
+Within the SMS step editor, write the message body.

-Novu automatically sends the notification to the phone number stored on the subscriber's profile . You must ensure that this field is set for any subscriber who needs to receive emails.
+Novu automatically sends the notification to the phone number stored on the subscriber's profile. You must ensure that this field is set for any subscriber who needs to receive SMS.

-Renders the email template.
-Delivers the message through the configured email integration.
+Renders the SMS template.
+Delivers the message through the configured SMS integration.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
The SMS channel delivers messages to your subscribers’ mobile devices through your configured SMS provider integrations.
With the SMS channel, you can:
## How SMS delivery works in Novu
- **Switch Providers Effortlessly:** Integrate popular services like Twilio, Nexmo, or a custom provider
- **Deliver at Scale:** Handle high-volume messaging with confidence
- **Customize and Track:** Tailor SMS content dynamically and monitor delivery status in real time
Here’s the typical flow for sending an email notification through Novu:
## Key Features
<Steps>
<Step>
- **Dynamic Messaging:** Inject user-specific data into messages for personalization
- **Multi-Provider Support:** Switch or combine providers to maximize reliability
- **Delivery Insights:** Track message delivery, failures, and user engagement
- **Fallback Mechanisms:** Ensure reliable messaging with backup providers
- **Template Management:** Simplify content creation with reusable SMS templates
- **Streamlined API Integration:** Easily connect your backend for automated messaging workflows
### Add an email provider
## Common Use Cases
Start by adding an SMS provider in the **Integration Store** on your Novu dashboard. You can connect one or more integrations for the different or the same providers.
- **Transactional Notifications:** Send OTPs, receipts, or order updates instantly
- **Marketing Campaigns:** Deliver promotional offers and updates to your audience
- **Critical Alerts:** Notify users of urgent events, like security breaches or system outages
- **Reminders and Scheduling:** Automate reminders for appointments, events, or deadlines
To learn [how to add an SMS provider](/platform/integrations/sms#supported-providers), refer to the guide for that provider.
</Step>
<Step>
### Add the email channel to your workflow
Next, include an [SMS step in your workflow](/platform/workflow/build-a-workflow). This step defines when and how an SMS should be sent as part of your notification workflow.
</Step>
<Step>
### Define the SMS content
## Sending SMS overrides
Within the Email step editor, write the message body. The editor supports dynamic data for personalized content.
The overrides field supports a `sms` property and `from`, `to`, `content` field overrides. This allows you to send a message to a different recipient, from a different sender, or with a different content.
</Step>
<Step>
### Store subscriber phone number
Novu automatically sends the notification to the phone number stored on the subscriber's profile . You must ensure that this field is set for any subscriber who needs to receive emails. You can store subscribers phone number using the Novu API, or SDK.
</Step>
<Step>
### 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.
</Step>
</Steps>
The SMS channel delivers messages to your subscribers’ mobile devices through your configured SMS provider integrations.
## How SMS delivery works in Novu
Here’s the typical flow for sending an SMS notification through Novu:
<Steps>
<Step>
### Add an SMS provider
Start by adding an SMS 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 SMS provider](/platform/integrations/sms#supported-providers), refer to the guide for that provider.
</Step>
<Step>
### Add the SMS channel to your workflow
Next, include an [SMS step in your workflow](/platform/workflow/build-a-workflow). This step defines when and how an SMS should be sent as part of your notification workflow.
</Step>
<Step>
### Define the SMS content
Within the SMS step editor, write the message body. The editor supports dynamic data for personalized content.
</Step>
<Step>
### Store subscriber phone number
Novu automatically sends the notification to the phone number stored on the subscriber's profile. You must ensure that this field is set for any subscriber who needs to receive SMS. You can store subscribers phone number using the Novu API, or SDK.
</Step>
<Step>
### 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 SMS template.
- Delivers the message through the configured SMS integration.
</Step>
</Steps>
🤖 Prompt for AI Agents
In content/docs/platform/integrations/sms/index.mdx around lines 8 to 50,
multiple copy-paste references to "email" should be replaced with "SMS": change
"sending an email notification" to "sending an SMS notification", "Add an email
provider" to "Add an SMS provider", "Add the email channel" to "Add the SMS
channel", "Within the Email step editor" to "Within the SMS step editor",
"receive emails" to "receive SMS", "Renders the email template" to "Renders the
SMS template", and "through the configured email integration" to "through the
configured SMS integration" so all step text consistently refers to SMS rather
than email.


<Callout type="info">Some countries restrict using verified `from` sender IDs (name). Kindly check the country- and provider-specific requirements first.</Callout>

## Configuring SMS providers

To add an SMS provider from the **Integration Store**, you must configure settings and credentials that are specific to that email providers.

### Default sender settings

The **From** field, which is displayed as the sender of the SMS, is a required default setting for any email provider that you connect. You can override this field during trigger if necessary.

### Provider authentication

You must provide credentials specific to your email provider, such as:
- API key
- Auth token
- Account SID
- Username
- Password.

Each provider has different requirements.

<Callout type="info"> Refer to the [supported SMS providers](/platform/integrations/sms#supported-providers) list for detailed setup guides for each provider integration.</Callout>
Comment on lines +54 to +73
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🔴 Critical

Fix copy-paste errors in configuration section: "email" should be "SMS".

Additional instances of "email" incorrectly used in the configuration section:

  • Line 56: "specific to that email providers" → should be "SMS providers"
  • Line 60: "any email provider that you connect" → should be "SMS provider"
  • Line 64: "your email provider" → should be "SMS provider"

Apply this diff:

-To add an SMS provider from the **Integration Store**, you must configure settings and credentials that are specific to that email providers.
+To add an SMS provider from the **Integration Store**, you must configure settings and credentials that are specific to that SMS provider.

-The **From** field, which is displayed as the sender of the SMS, is a required default setting for any email provider that you connect.
+The **From** field, which is displayed as the sender of the SMS, is a required default setting for any SMS provider that you connect.

-You must provide credentials specific to your email provider, such as:
+You must provide credentials specific to your SMS provider, such as:
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
## Configuring SMS providers
To add an SMS provider from the **Integration Store**, you must configure settings and credentials that are specific to that email providers.
### Default sender settings
The **From** field, which is displayed as the sender of the SMS, is a required default setting for any email provider that you connect. You can override this field during trigger if necessary.
### Provider authentication
You must provide credentials specific to your email provider, such as:
- API key
- Auth token
- Account SID
- Username
- Password.
Each provider has different requirements.
<Callout type="info"> Refer to the [supported SMS providers](/platform/integrations/sms#supported-providers) list for detailed setup guides for each provider integration.</Callout>
## Configuring SMS providers
To add an SMS provider from the **Integration Store**, you must configure settings and credentials that are specific to that SMS provider.
### Default sender settings
The **From** field, which is displayed as the sender of the SMS, is a required default setting for any SMS provider that you connect. You can override this field during trigger if necessary.
### Provider authentication
You must provide credentials specific to your SMS provider, such as:
- API key
- Auth token
- Account SID
- Username
- Password.
Each provider has different requirements.
<Callout type="info"> Refer to the [supported SMS providers](/platform/integrations/sms#supported-providers) list for detailed setup guides for each provider integration.</Callout>
🤖 Prompt for AI Agents
In content/docs/platform/integrations/sms/index.mdx around lines 54 to 73, there
are copy-paste errors using "email" instead of "SMS"; update the text to read:
"specific to that SMS provider" (line ~56), "any SMS provider that you connect"
(line ~60), and "your SMS provider" (line ~64), and adjust surrounding wording
for correct singular/plural agreement if needed.


## Override SMS settings

You can override the SMS settings when triggerring a notification by passing the `overrides` object. The overrides object field supports an `sms` property and `from`, `to`, and `content` field overrides. This lets you send a message to a different recipient, from a different sender, or with a different content.

```javascript
import { Novu } from '@novu/api';
Expand All @@ -49,7 +90,7 @@ await novu.trigger({
to: {
subscriberId: "subscriberId",
},
overrides: {
overrides: { // [!code ++:7]
sms: {
to: '+123012345678',
from: 'Novu Team',
Expand All @@ -59,18 +100,11 @@ await novu.trigger({
});
```

## Using different SMS integration

In Novu integration store, multiple SMS 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 SMS by default. If you want to use a different active provider integration then you can use the `integrationIdentifier` sms overrides field.
## Target a specific provider

If there are 4 active SMS integrations with these identifiers:-
By default, Novu uses your primary SMS provider. If you want to bypass this and force a specific, active integration for a trigger, then use the `integrationIdentifier`.

1. twilio-abcdef
2. twilio-ghijkl
3. firetext-abcdef
4. infobip-abcdef

Here, if `twilio-abcdef` is primary integration and you want to use `infobip-abcdef` with this trigger then you can use `integrationIdentifier` sms overrides field as below:-
This is useful if you have multiple active integrations for different purposes. For example, you might have one integration for transactional SMS and one for security SMS. You can find the `integrationIdentifier` in the **Integration Store** of the Novu dashboard.

<Tabs items={['Node.js']}>
<Tab value="Node.js">
Expand All @@ -89,7 +123,7 @@ await novu.trigger({
to: {
subscriberId: "subscriberId",
},
overrides: {
overrides: { // [!code ++:3]
sms: { integrationIdentifier: 'infobip-abcdef', },
},
});
Expand All @@ -98,13 +132,32 @@ await novu.trigger({
</Tab>
</Tabs>

<Callout type="info">
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.
</Callout>

## Common errors

Common errors and reason for these errors while sending sms messages using Novu.

1. Subscriber does not have a configured channel.
- if the `from` field is missing / null / undefined.
## Supported providers

Here are the SMS providers that are currently supported by Novu. Select any provider to see its detailed setup guide.

<Cards>
<Card title="46elks" href="/platform/integrations/sms/46elks"> Learn how to use the 46elks provider to send SMS notifications using Novu.</Card>
<Card title="Africa's Talking" href="/platform/integrations/sms/africas-talking"> Learn how to use the Africa's Talking provider to send SMS notifications using Novu.</Card>
<Card title="AWS SNS" href="/platform/integrations/sms/aws-sns"> Learn how to use the AWS SNS provider to send SMS notifications using Novu.</Card>
<Card title="Azure SMS" href="/platform/integrations/sms/azure-sms"> Learn how to use the Azure SMS provider to send SMS notifications using Novu.</Card>
<Card title="BulkSMS" href="/platform/integrations/sms/bulksms"> Learn how to use the BulkSMS provider to send SMS notifications using Novu.</Card>
<Card title="Clickatell" href="/platform/integrations/sms/clickatell"> Learn how to use the Clickatell provider to send SMS notifications using Novu.</Card>
<Card title="Clicksend" href="/platform/integrations/sms/clicksend"> Learn how to use the Clicksend provider to send SMS notifications using Novu.</Card>
<Card title="Firetext" href="/platform/integrations/sms/firetext"> Learn how to use the Firetext provider to send SMS notifications using Novu.</Card>
<Card title="Gupshup" href="/platform/integrations/sms/gupshup"> Learn how to use the Gupshup provider to send SMS notifications using Novu.</Card>
<Card title="Infobip - SMS" href="/platform/integrations/sms/infobip"> Learn how to use the Infobip - SMS provider to send SMS notifications using Novu.</Card>
<Card title="Kannel" href="/platform/integrations/sms/kannel"> Learn how to use the Kannel provider to send SMS notifications using Novu.</Card>
<Card title="Kudosity" href="/platform/integrations/sms/kudosity"> Learn how to use the Kudosity provider to send SMS notifications using Novu.</Card>
<Card title="MessageBird" href="/platform/integrations/sms/messagebird"> Learn how to use the MessageBird provider to send SMS notifications using Novu.</Card>
<Card title="Nexmo" href="/platform/integrations/sms/nexmo"> Learn how to use the Nexmo provider to send SMS notifications using Novu.</Card>
<Card title="Plivo" href="/platform/integrations/sms/plivo"> Learn how to use the Plivo provider to send SMS notifications using Novu.</Card>
<Card title="Sendchamp" href="/platform/integrations/sms/sendchamp"> Learn how to use the Sendchamp provider to send SMS notifications using Novu.</Card>
<Card title="SimpleTexting" href="/platform/integrations/sms/simpletexting"> Learn how to use the SimpleTexting provider to send SMS notifications using Novu.</Card>
<Card title="SMS Central" href="/platform/integrations/sms/sms-central"> Learn how to use the SMS Central provider to send SMS notifications using Novu.</Card>
<Card title="SMS77" href="/platform/integrations/sms/sms77"> Learn how to use the SMS77 provider to send SMS notifications using Novu.</Card>
<Card title="SNS" href="/platform/integrations/sms/sns"> Learn how to use the SNS provider to send SMS notifications using Novu.</Card>
<Card title="Telnyx" href="/platform/integrations/sms/telnyx"> Learn how to use the Telnyx provider to send SMS notifications using Novu.</Card>
<Card title="Termii" href="/platform/integrations/sms/termii"> Learn how to use the Termii provider to send SMS notifications using Novu.</Card>
<Card title="Twilio" href="/platform/integrations/sms/twilio"> Learn how to use the Twilio provider to send SMS notifications using Novu.</Card>
</Cards>
Comment on lines +135 to +163
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🔴 Critical

🧩 Analysis chain

Supported providers gallery is comprehensive and well-organized.

The Cards component provides an excellent visual showcase of 25+ SMS providers with clear navigation. The consistent description format and href links create a usable provider directory.

Verify that all provider documentation pages linked in the href attributes (e.g., /platform/integrations/sms/46elks, /platform/integrations/sms/twilio) exist and are correctly named.


🏁 Script executed:

#!/bin/bash
# Description: Verify that all SMS provider documentation pages exist

# Extract all hrefs from the Supported providers section
provider_paths=$(grep -oP '(?<=href="/platform/integrations/sms/)[^"]+' content/docs/platform/integrations/sms/index.mdx)

# Check which provider pages exist
echo "Checking provider documentation pages..."
for provider in $provider_paths; do
  provider_file="content/docs/platform/integrations/sms/${provider}.mdx"
  if [ -f "$provider_file" ]; then
    echo "✓ Found: $provider"
  else
    echo "✗ Missing: $provider"
  fi
done

Length of output: 495


Looking at the verification results, I need to check if the provider documentation pages exist under a different directory structure or naming convention before finalizing the assessment.

Critical issue: All 23 SMS provider documentation pages are missing from the repository.

The Novu documentation includes all listed providers (46elks, Africa's Talking, AWS SNS, Azure SMS, BulkSMS, Clickatell, Clicksend, Firetext, Gupshup, Kannel, MessageBird, Nexmo, Plivo, Sendchamp, SimpleTexting, SMS Central, SMS77, SNS, Telnyx, Termii, Twilio, and others), however the corresponding .mdx source files do not exist in the content/docs/platform/integrations/sms/ directory. The index page contains href links to these provider pages, but the pages themselves need to be created or sourced from the main documentation repository.

Either:

  1. Create all missing provider documentation files, OR
  2. Remove the provider cards from index.mdx until the documentation pages are ready, OR
  3. Confirm these files are built/generated separately in the CI/CD pipeline

🏁 Script executed:

#!/bin/bash
# Search for any SMS provider documentation files in the codebase
# Check different possible locations and naming patterns

echo "Searching for provider documentation files..."
echo ""

# Check if provider pages exist in content/docs/platform/integrations/sms/ directory
echo "Files in content/docs/platform/integrations/sms/:"
if [ -d "content/docs/platform/integrations/sms/" ]; then
  find content/docs/platform/integrations/sms/ -type f -name "*.mdx" | sort
else
  echo "Directory not found"
fi

echo ""
echo "Searching for any files with provider names (case-insensitive):"
# Search for files containing provider names
for provider in "twilio" "nexmo" "aws-sns" "plivo"; do
  echo "Searching for '$provider'..."
  find content/docs -type f -name "*${provider}*" 2>/dev/null || echo "  (no matches)"
done

Length of output: 2078


Looking at the new results, the provider files exist in a (providers) subdirectory. I need to verify if the href links in index.mdx correctly match the actual provider filenames.


🏁 Script executed:

#!/bin/bash
# Extract all hrefs from index.mdx and compare with actual provider filenames

echo "Comparing index.mdx href links with actual provider files..."
echo ""

# Get hrefs from index.mdx
echo "href links from index.mdx:"
grep -oP '(?<=href="/platform/integrations/sms/)[^"]+' content/docs/platform/integrations/sms/index.mdx > /tmp/hrefs.txt
cat /tmp/hrefs.txt

echo ""
echo "Actual provider filenames (without .mdx extension):"
find content/docs/platform/integrations/sms/\(providers\)/ -type f -name "*.mdx" -exec basename {} .mdx \; | sort > /tmp/files.txt
cat /tmp/files.txt

echo ""
echo "Mismatches between href links and filenames:"
# Compare the two lists
comm -23 <(sort /tmp/hrefs.txt) <(sort /tmp/files.txt) | sed 's/^/  href link not found: /'
comm -13 <(sort /tmp/hrefs.txt) <(sort /tmp/files.txt) | sed 's/^/  file exists but not linked: /'

Length of output: 676


Fix 2 broken provider links in the Cards component.

Two href links in the index.mdx file do not match the actual provider documentation filenames:

  1. Line ~145 – Change href="/platform/integrations/sms/azure-sms" to href="/platform/integrations/sms/azure" (file is azure.mdx, not azure-sms.mdx)
  2. Line ~148 – Change href="/platform/integrations/sms/bulksms" to href="/platform/integrations/sms/bulk-sms" (file is bulk-sms.mdx, not bulksms.mdx)

All other 21 provider links match their corresponding .mdx files correctly.

🤖 Prompt for AI Agents
In content/docs/platform/integrations/sms/index.mdx around lines 135–163, two
Card hrefs point to incorrect filenames: update the Card with title "Azure SMS"
to use href="/platform/integrations/sms/azure" (file is azure.mdx) and update
the Card with title "BulkSMS" to use href="/platform/integrations/sms/bulk-sms"
(file is bulk-sms.mdx); change those two href attributes accordingly and leave
the other Card links unchanged.

2 changes: 1 addition & 1 deletion content/docs/platform/integrations/sms/meta.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"icon": "MessageCircle",
"pages": ["adding-sms", "..."]
"pages": ["(providers)"]
}
69 changes: 46 additions & 23 deletions content/docs/platform/integrations/trigger-overrides.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,32 @@ description: 'Learn how to customize the behavior of your workflows at trigger t
icon: 'SlidersVertical'
---

import { Mail, MessageSquare } from 'lucide-react';
import { Card, Cards } from 'fumadocs-ui/components/card';


Trigger overrides let you to modify the default behavior of specific aspects of a workflow trigger (event), giving you fine-tuned control over how messages are delivered across different channels and providers.

## Channel overrides

Channel overrides let you customize specific channel settings and content during workflow trigger. Each channel has its own supported override options, documented in their respective channel guides.

<Callout>Channel overrides is only available for Email and SMS channels.</Callout>

<Cards>
<Card
title="Email overrides"
icon={<Mail className="h-4 w-4" />}
href="/platform/integrations/email"
/>
<Card
title="SMS overrides"
icon={<MessageSquare className="h-4 w-4" />}
href="/platform/integrations/sms"
/>
</Cards>


## Provider overrides

Provider overrides give you fine-tuned control over how messages are delivered by allowing direct configuration of the underlying provider SDKs during the workflow's trigger phase.
Expand All @@ -21,13 +45,13 @@ This mechanism offers a flexible customization layer that lets you pass deeply n

<Callout type="info">Because overrides interact directly with provider SDKs, they won’t work if they're misconfigured. Make sure you understand the supported options for each provider before using this feature. </Callout>

### Override structure
### Provider override scopes

Overrides are defined in the `overrides` property of a trigger payload. You can specify configuration values at two levels:
- Workflow-level: Applies to all steps using a specific provider and takes precedence over the default workflow provider settings.
- Step-level: Targets a specific step in the workflow and it takes precedence over both workflow-level overrides and the default workflow provider settings.

#### Workflow-level provider overrides
### Workflow-level provider overrides

Workflow-level provider overrides apply configuration to all steps that use a given provider in the workflow. They’re useful for applying shared logic across multiple steps, without repeating the same settings in each one.

Expand Down Expand Up @@ -78,7 +102,25 @@ run();

This configuration affects every step in the workflow that uses SendGrid, unless a step-level override provides a more specific value.

#### Step-level provider overrides
#### Sending extra fields supported by provider SDK

You can also send extra fields supported by the provider SDK. For example, if you want to send a headers to the provider SDK, then you could use the `_passthrough` field.

```json
"overrides": {
"providers" : {
"sendgrid": {
"_passthrough": {
"headers": {
"Authorization": "Bearer my-api-key"
}
}
},
},
},
```
Comment on lines +105 to +121
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Fix grammatical error in introductory sentence.

Line 107 has a grammatical issue: "if you want to send a headers" should be "if you want to send headers" (remove the article "a" since "headers" is plural).

The _passthrough JSON example itself is clear and well-structured.

-You can also send extra fields supported by the provider SDK. For example, if you want to send a headers to the provider SDK, then you could use the `_passthrough` field.
+You can also send extra fields supported by the provider SDK. For example, if you want to send headers to the provider SDK, you could use the `_passthrough` field.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
#### Sending extra fields supported by provider SDK
You can also send extra fields supported by the provider SDK. For example, if you want to send a headers to the provider SDK, then you could use the `_passthrough` field.
```json
"overrides": {
"providers" : {
"sendgrid": {
"_passthrough": {
"headers": {
"Authorization": "Bearer my-api-key"
}
}
},
},
},
```
#### Sending extra fields supported by provider SDK
You can also send extra fields supported by the provider SDK. For example, if you want to send headers to the provider SDK, you could use the `_passthrough` field.
🤖 Prompt for AI Agents
In content/docs/platform/integrations/trigger-overrides.mdx around lines 105 to
121, the introductory sentence contains a grammatical error: change "if you want
to send a headers" to "if you want to send headers" (remove the extraneous
article "a") so the sentence reads correctly while leaving the JSON _passthrough
example unchanged.


### Step-level overrides

Step-level overrides let you apply provider-specific settings directly to an individual step in your workflow.

Expand Down Expand Up @@ -142,23 +184,4 @@ run();

<Callout>The `push-step` refers to the step identifier, which you can copy directly from your workflow in the Novu dashboard. Use this identifier to target the specific step you want to override. </Callout>

In this example, only the `push-step` is affected, and multiple FCM-specific settings are overridden for that step, which are the notification title, body, and sound configurations for both Android and iOS platforms.


#### Sending extra fields supported by provider sdk

You can also send extra fields supported by the provider SDK. For example, if you want to send a headers to the provider SDK, you can do it by using the `_passthrough` field.

```json
"overrides": {
"providers" : {
"sendgrid": {
"_passthrough": {
"headers": {
"Authorization": "Bearer my-api-key"
}
}
},
},
},
```
In this example, only the `push-step` is affected, and multiple FCM-specific settings are overridden for that step, which are the notification title, body, and sound configurations for both Android and iOS platforms.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.