Chat Providers Integration

The Chat channel delivers messages to your subscribers via their preferred chat platforms and application.

Messaging platforms vs. Messaging applications

• Messaging platforms: Ideal for structured, workplace communication. Use these to notify teams or users in collaborative environments. Examples: Slack, Teams
• Messaging apps: Best for consumer-facing messaging. Engage users directly through personal or group chats. Examples: WhatsApp, Telegram, Discord

How chat delivery works in Novu

Here’s the typical flow for sending a chat notification through Novu:

Configuring chat providers

When you add a chat provider in the Integration Store, you'll configure credentials specific to that provider.

Provider authentication

You may need to provide credentials specific to your chat provider, such as an API key, Client ID, or Client Secret. However, some providers, like Discord, may not require any global credentials to be set in the Integration Store.

Each provider has different requirements.

How to manages Chat credentials

The chat channel works by storing specific credentials for each subscriber. This credential is typically a webhookUrl that tells Novu where to send a message for that specific subscriber.

Before triggering a chat notification, you must update the subscriber with this webhookUrl.

Storing subscriber credentials

Use the subscribers.credentials.update method to store the webhookUrl for a specific subscriber and provider.

Checkout the API reference for more details.

import { Novu } from '@novu/api';
import { ChatOrPushProviderEnum } from "@novu/api/models/components";
 
const novu = new Novu({
  secretKey: "<NOVU_SECRET_KEY>",
  // Use serverURL for EU region
  // serverURL: "https://eu.api.novu.co",
});
 
await novu.subscribers.credentials.update(
  {
    providerId: ChatOrPushProviderEnum.Discord,
    credentials: {
      webhookUrl: "<WEBHOOK_URL>",
    },
    integrationIdentifier: "discord-MnGLxp8uy",
  },
  "subscriberId"
);

Supported providers

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