Multi-tenancy

Multi-tenancy is a common use case for a lot of companies that have multiple organizations that use their applications. In some cases, there is a need to separate the behavior of the notification system depending on the individual tenants. Tenants are also commonly called workspaces or organizations. Some of the common multi-tenancy use cases are:

Group subscribers notification feeds by the tenant
Adjust the content of the notification depending on the tenant

How to implement multi-tenancy in Novu

Novu supports multi-tenancy out of the box, the most simple way to implement tenant separation is by prefixing the subscriber identifier with the

import { Novu } from "@novu/api";

const novu = new Novu({ secretKey: "<YOUR_SECRET_KEY_HERE>" });

const subscriberId = `${tenantId}:${userId}`;

await novu.trigger({
  workflowId: "workflow_identifier",
  to: { subscriberId },
  payload: { tenantId },
});

import os
import novu_py
from novu_py import Novu

subscriber_id = f"{tenant_id}:{user_id}"

with Novu(secret_key=os.getenv("NOVU_SECRET_KEY", "")) as novu:
    novu.trigger(trigger_event_request_dto=novu_py.TriggerEventRequestDto(
        workflow_id="workflow_identifier",
        to={"subscriber_id": subscriber_id},
        payload={"tenantId": tenant_id},
    ))

import (
    "context"
    "fmt"
    "os"

    novugo "github.com/novuhq/novu-go"
    "github.com/novuhq/novu-go/models/components"
)

s := novugo.New(novugo.WithSecurity(os.Getenv("NOVU_SECRET_KEY")))

subscriberID := fmt.Sprintf("%s:%s", tenantID, userID)

res, err := s.Trigger(context.Background(), components.TriggerEventRequestDto{
    WorkflowID: "workflow_identifier",
    To: components.CreateToSubscriberPayloadDto(components.SubscriberPayloadDto{
        SubscriberID: subscriberID,
    }),
    Payload: map[string]any{
        "tenantId": tenantID,
    },
}, nil)

use novu;
use novu\Models\Components;

$sdk = novu\Novu::builder()
    ->setSecurity('<YOUR_SECRET_KEY_HERE>')
    ->build();

$subscriberId = "{$tenantId}:{$userId}";

$sdk->trigger(
    triggerEventRequestDto: new Components\TriggerEventRequestDto(
        workflowId: 'workflow_identifier',
        to: new Components\SubscriberPayloadDto(subscriberId: $subscriberId),
        payload: ['tenantId' => $tenantId],
    ),
);

using Novu;
using Novu.Models.Components;
using System.Collections.Generic;

var sdk = new NovuSDK(secretKey: "<YOUR_SECRET_KEY_HERE>");

var subscriberId = $"{tenantId}:{userId}";

await sdk.TriggerAsync(triggerEventRequestDto: new TriggerEventRequestDto() {
    WorkflowId = "workflow_identifier",
    To = To.CreateSubscriberPayloadDto(new SubscriberPayloadDto() {
        SubscriberId = subscriberId,
    }),
    Payload = new Dictionary<string, object>() {
        { "tenantId", tenantId },
    },
});

import co.novu.Novu;
import co.novu.models.components.*;
import java.util.Map;

Novu novu = Novu.builder()
    .secretKey("<YOUR_SECRET_KEY_HERE>")
    .build();

String subscriberId = tenantId + ":" + userId;

novu.trigger()
    .body(TriggerEventRequestDto.builder()
        .workflowId("workflow_identifier")
        .to(To2.of(SubscriberPayloadDto.builder()
            .subscriberId(subscriberId)
            .build()))
        .payload(Map.of("tenantId", tenantId))
        .build())
    .call();

curl -L -g -X POST 'https://api.novu.co/v1/events/trigger' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: ApiKey <NOVU_SECRET_KEY>' \
-d '{
    "name": "workflow_identifier",
    "to": { "subscriberId": "TENANT_ID:USER_ID" },
    "payload": { "tenantId": "TENANT_ID" }
}'

Tenant in Inbox

When using the Inbox feature, you can use the tenant identifier to group notifications by tenant.

import { Inbox } from "@novu/react";

function InboxComponent({ tenantId, userId }) {
  return <Inbox subscriber={`${tenantId}:${userId}`} />;
}

Each subscriber in a tenant will have it’s own unique inbox feed, including a separate preference configuration set.

Adjusting notification content based on tenant

When triggering a notification, you can pass a custom tenant object or identifier and use it to manipulate workflows or content.

import { Novu } from "@novu/api";

const novu = new Novu({ secretKey: "<YOUR_SECRET_KEY_HERE>" });

const subscriberId = `${tenantId}:${userId}`;

await novu.trigger({
  workflowId: "workflow_identifier",
  to: { subscriberId },
  payload: {
    tenant: {
      id: tenantId,
      name: "Airbnb",
      logo: "https://airbnb.com/logo.png",
      primaryColor: "red",
    },
  },
});

import os
import novu_py
from novu_py import Novu

subscriber_id = f"{tenant_id}:{user_id}"

with Novu(secret_key=os.getenv("NOVU_SECRET_KEY", "")) as novu:
    novu.trigger(trigger_event_request_dto=novu_py.TriggerEventRequestDto(
        workflow_id="workflow_identifier",
        to={"subscriber_id": subscriber_id},
        payload={
            "tenant": {
                "id": tenant_id,
                "name": "Airbnb",
                "logo": "https://airbnb.com/logo.png",
                "primaryColor": "red",
            },
        },
    ))

import (
    "context"
    "fmt"
    "os"

    novugo "github.com/novuhq/novu-go"
    "github.com/novuhq/novu-go/models/components"
)

s := novugo.New(novugo.WithSecurity(os.Getenv("NOVU_SECRET_KEY")))

subscriberID := fmt.Sprintf("%s:%s", tenantID, userID)

res, err := s.Trigger(context.Background(), components.TriggerEventRequestDto{
    WorkflowID: "workflow_identifier",
    To: components.CreateToSubscriberPayloadDto(components.SubscriberPayloadDto{
        SubscriberID: subscriberID,
    }),
    Payload: map[string]any{
        "tenant": map[string]any{
            "id":           tenantID,
            "name":         "Airbnb",
            "logo":         "https://airbnb.com/logo.png",
            "primaryColor": "red",
        },
    },
}, nil)

use novu;
use novu\Models\Components;

$sdk = novu\Novu::builder()
    ->setSecurity('<YOUR_SECRET_KEY_HERE>')
    ->build();

$subscriberId = "{$tenantId}:{$userId}";

$sdk->trigger(
    triggerEventRequestDto: new Components\TriggerEventRequestDto(
        workflowId: 'workflow_identifier',
        to: new Components\SubscriberPayloadDto(subscriberId: $subscriberId),
        payload: [
            'tenant' => [
                'id' => $tenantId,
                'name' => 'Airbnb',
                'logo' => 'https://airbnb.com/logo.png',
                'primaryColor' => 'red',
            ],
        ],
    ),
);

using Novu;
using Novu.Models.Components;
using System.Collections.Generic;

var sdk = new NovuSDK(secretKey: "<YOUR_SECRET_KEY_HERE>");

var subscriberId = $"{tenantId}:{userId}";

await sdk.TriggerAsync(triggerEventRequestDto: new TriggerEventRequestDto() {
    WorkflowId = "workflow_identifier",
    To = To.CreateSubscriberPayloadDto(new SubscriberPayloadDto() {
        SubscriberId = subscriberId,
    }),
    Payload = new Dictionary<string, object>() {
        { "tenant", new Dictionary<string, object>() {
            { "id", tenantId },
            { "name", "Airbnb" },
            { "logo", "https://airbnb.com/logo.png" },
            { "primaryColor", "red" },
        } },
    },
});

import co.novu.Novu;
import co.novu.models.components.*;
import java.util.Map;

Novu novu = Novu.builder()
    .secretKey("<YOUR_SECRET_KEY_HERE>")
    .build();

String subscriberId = tenantId + ":" + userId;

novu.trigger()
    .body(TriggerEventRequestDto.builder()
        .workflowId("workflow_identifier")
        .to(To2.of(SubscriberPayloadDto.builder()
            .subscriberId(subscriberId)
            .build()))
        .payload(Map.of("tenant", Map.ofEntries(
            Map.entry("id", tenantId),
            Map.entry("name", "Airbnb"),
            Map.entry("logo", "https://airbnb.com/logo.png"),
            Map.entry("primaryColor", "red"))))
        .build())
    .call();

curl -L -g -X POST 'https://api.novu.co/v1/events/trigger' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: ApiKey <NOVU_SECRET_KEY>' \
-d '{
    "name": "workflow_identifier",
    "to": { "subscriberId": "TENANT_ID:USER_ID" },
    "payload": {
        "tenant": {
            "id": "TENANT_ID",
            "name": "Airbnb",
            "logo": "https://airbnb.com/logo.png",
            "primaryColor": "red"
        }
    }
}'

The tenant object will be available to use in the workflow editor as a variable for the following areas:

Content (use {{payload.tenant.name}} to display the tenant name in an email or any other channel)
Step Conditions (use {{payload.tenant.id}} to conditionally execute a step based on the tenant)
Use the Inbox data object to filter notifications by tenant.

Frequently asked questions

The following are the frequently asked questions about multi-tenancy in Novu.

Can I use a different delivery provider for each tenant?

Currently, we do not support using a different delivery provider for each tenant. You can reach out to [email protected] in case this is a feature required for your use case.

Can I specify different workflow preferences for each tenant?

We don’t support specifying different workflow preferences for each tenant. You can reach out to [email protected] in case this is a feature required for your use case.

​How to implement multi-tenancy in Novu

​Tenant in Inbox

​Adjusting notification content based on tenant

​Frequently asked questions

How to implement multi-tenancy in Novu

Tenant in Inbox

Adjusting notification content based on tenant

Frequently asked questions