Novu Integration Hub

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 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.

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".

Provider vs. Integration

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.

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.

Primary vs. Active integrations

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

• 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. 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.

Integration guides

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