Skip to content
Merged
Changes from all commits
Commits
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
84 changes: 40 additions & 44 deletions content/docs/platform/additional-resources/glossary.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,69 +6,31 @@

## Introduction

In this section, you'll find a list of key terms, their definitions and various concepts associated with Novu. Familiarising yourself with these will help you understand and use Novu better. They will help you navigate our docs more effectively and utilise Novu to its maximum potential.

Check warning on line 9 in content/docs/platform/additional-resources/glossary.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

content/docs/platform/additional-resources/glossary.mdx#L9

Did you really mean 'Novu'?

Check warning on line 9 in content/docs/platform/additional-resources/glossary.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

content/docs/platform/additional-resources/glossary.mdx#L9

Did you really mean 'Novu'?

Check warning on line 9 in content/docs/platform/additional-resources/glossary.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

content/docs/platform/additional-resources/glossary.mdx#L9

Did you really mean 'Novu'?

If you have any questions or need further clarification on any of the terms listed above, please feel free to reach out to our support team or join our community!

## List of key terms and definitions

### Notification

A brief message or alert that informs users about events, updates, or some other information.

### Channels

Novu lets you send notifications across different communication mediums, including emails, in-app messages, push notifications, SMS, and chat. Each of these five communication mediums is referred to as a notification 'channel'.

<img src="/images/channels.gif" alt="Channels in Novu" />

### Providers

Providers are responsible for handling message delivery across various channels. Novu currently supports multiple notification channels, each with its own set of providers.

- Chat: Discord, MS Teams, Slack, Zulip
- Email: Sendgrid, Amazon SES, Brevo, Resend, SparkPost, Postmark, Mailjet, Mailtrap, Plunk, Braze, Mailersend, Outlook 365, Mailgun, Mandrill, Netcore, Infobip, Custom SMTP
- SMS: Twilio SMS, SMS77, Africa's Talking, Infobip, Nexmo, Plivo, Sendchamp, AWS SNS, Telnyx, Termii, Firetext, Gupshup, Clickatell, Azure SMS, BulkSMS, SimpleTexting, MessageBird
- Push Notification: Firebase Cloud Messaging (FCM), Expo Push, Apple Push Notification Service (APNS), One Signal, Pushpad, Pusher Beams, Push Webhook
- Inbox: React component, Angular component, Vue component, Web component, iFrame embed, Custom styling, Headless Inbox

### Subscribers

Subscribers are entities designated to receive the notifications you send. Each subscriber in Novu is uniquely identified by their `subscriberId`.

### Actor

An `actor` refers to a user or subscriber who initiates actions that trigger events within the system. Each actor is uniquely identified by an "actorId," also known as "subscriberId". Actors hold user-related variables and can enhance notifications by allowing their avatars to be displayed.

Check warning on line 17 in content/docs/platform/additional-resources/glossary.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

content/docs/platform/additional-resources/glossary.mdx#L17

Did you really mean 'actorId'?

Check warning on line 17 in content/docs/platform/additional-resources/glossary.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

content/docs/platform/additional-resources/glossary.mdx#L17

Did you really mean 'subscriberId'?

### Workflow

Workflow templates define the flow of messages sent to subscribers.

### Topics

Topics facilitate bulk notifications to multiple subscribers simultaneously, streamlining communication.

### Digest Engine
### Channels

The digest engine aggregates multiple trigger events into a single message, ensuring efficient communication.
Novu lets you send notifications across different communication mediums, including emails, in-app messages, push notifications, SMS, and chat. Each of these five communication mediums is referred to as a notification 'channel'.

Check warning on line 21 in content/docs/platform/additional-resources/glossary.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

content/docs/platform/additional-resources/glossary.mdx#L21

Did you really mean 'Novu'?

### Delay Actions

Delay actions introduce time intervals between workflow steps, optimizing message delivery timing.

### Step Filter

Step filters customize workflow by specifying notification criteria, enhancing communication efficiency.

### Organizations

Organizations allow separation of notifications across multiple products, managed through the Novu web dashboard.
### Digest Engine

<img src="/images/org.gif" alt="Organizations in Novu" />
The digest engine aggregates multiple trigger events into a single message, ensuring efficient communication.

### Environments

Novu runs all your requests in the context of an environment. By default, Novu creates two environments:

Check warning on line 33 in content/docs/platform/additional-resources/glossary.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

content/docs/platform/additional-resources/glossary.mdx#L33

Did you really mean 'Novu'?

Check warning on line 33 in content/docs/platform/additional-resources/glossary.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

content/docs/platform/additional-resources/glossary.mdx#L33

Did you really mean 'Novu'?

1. Development environment: For testing purposes and validating notification changes
2. Production environment: Your live environment (read-only, changes must be promoted from development)
Expand All @@ -83,10 +45,44 @@
- Notification feeds (can be promoted to production)
- Brand-related assets and settings

### Layouts

Layouts are HTML designs or structures to wrap the content of email notifications. Layouts can be manipulated and assigned to new or existing workflows within the Novu platform.

Check warning on line 50 in content/docs/platform/additional-resources/glossary.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

content/docs/platform/additional-resources/glossary.mdx#L50

Did you really mean 'Novu'?

### Notification

A brief message or alert that informs users about events, updates, or some other information.

### Organizations

Organizations allow separation of notifications across multiple products, managed through the Novu web dashboard.

Check warning on line 58 in content/docs/platform/additional-resources/glossary.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

content/docs/platform/additional-resources/glossary.mdx#L58

Did you really mean 'Novu'?

### Providers

Providers are responsible for handling message delivery across various channels. Novu currently supports multiple notification channels, each with its own set of providers.

Check warning on line 62 in content/docs/platform/additional-resources/glossary.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

content/docs/platform/additional-resources/glossary.mdx#L62

Did you really mean 'Novu'?

- Chat: Discord, MS Teams, Slack, Zulip

Check warning on line 64 in content/docs/platform/additional-resources/glossary.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

content/docs/platform/additional-resources/glossary.mdx#L64

Did you really mean 'Zulip'?
- Email: Sendgrid, Amazon SES, Brevo, Resend, SparkPost, Postmark, Mailjet, Mailtrap, Plunk, Braze, Mailersend, Outlook 365, Mailgun, Mandrill, Netcore, Infobip, Custom SMTP

Check warning on line 65 in content/docs/platform/additional-resources/glossary.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

content/docs/platform/additional-resources/glossary.mdx#L65

Did you really mean 'Sendgrid'?

Check warning on line 65 in content/docs/platform/additional-resources/glossary.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

content/docs/platform/additional-resources/glossary.mdx#L65

Did you really mean 'Brevo'?

Check warning on line 65 in content/docs/platform/additional-resources/glossary.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

content/docs/platform/additional-resources/glossary.mdx#L65

Did you really mean 'Mailjet'?

Check warning on line 65 in content/docs/platform/additional-resources/glossary.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

content/docs/platform/additional-resources/glossary.mdx#L65

Did you really mean 'Mailtrap'?

Check warning on line 65 in content/docs/platform/additional-resources/glossary.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

content/docs/platform/additional-resources/glossary.mdx#L65

Did you really mean 'Mailersend'?

Check warning on line 65 in content/docs/platform/additional-resources/glossary.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

content/docs/platform/additional-resources/glossary.mdx#L65

Did you really mean 'Mailgun'?

Check warning on line 65 in content/docs/platform/additional-resources/glossary.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

content/docs/platform/additional-resources/glossary.mdx#L65

Did you really mean 'Netcore'?

Check warning on line 65 in content/docs/platform/additional-resources/glossary.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

content/docs/platform/additional-resources/glossary.mdx#L65

Did you really mean 'Infobip'?
- SMS: Twilio SMS, SMS77, Africa's Talking, Infobip, Nexmo, Plivo, Sendchamp, AWS SNS, Telnyx, Termii, Firetext, Gupshup, Clickatell, Azure SMS, BulkSMS, SimpleTexting, MessageBird

Check warning on line 66 in content/docs/platform/additional-resources/glossary.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

content/docs/platform/additional-resources/glossary.mdx#L66

Did you really mean 'Twilio'?

Check warning on line 66 in content/docs/platform/additional-resources/glossary.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

content/docs/platform/additional-resources/glossary.mdx#L66

Did you really mean 'Infobip'?

Check warning on line 66 in content/docs/platform/additional-resources/glossary.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

content/docs/platform/additional-resources/glossary.mdx#L66

Did you really mean 'Nexmo'?

Check warning on line 66 in content/docs/platform/additional-resources/glossary.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

content/docs/platform/additional-resources/glossary.mdx#L66

Did you really mean 'Plivo'?

Check warning on line 66 in content/docs/platform/additional-resources/glossary.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

content/docs/platform/additional-resources/glossary.mdx#L66

Did you really mean 'Sendchamp'?

Check warning on line 66 in content/docs/platform/additional-resources/glossary.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

content/docs/platform/additional-resources/glossary.mdx#L66

Did you really mean 'Telnyx'?

Check warning on line 66 in content/docs/platform/additional-resources/glossary.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

content/docs/platform/additional-resources/glossary.mdx#L66

Did you really mean 'Termii'?

Check warning on line 66 in content/docs/platform/additional-resources/glossary.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

content/docs/platform/additional-resources/glossary.mdx#L66

Did you really mean 'Firetext'?

Check warning on line 66 in content/docs/platform/additional-resources/glossary.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

content/docs/platform/additional-resources/glossary.mdx#L66

Did you really mean 'Gupshup'?
- Push Notification: Firebase Cloud Messaging (FCM), Expo Push, Apple Push Notification Service (APNS), One Signal, Pushpad, Pusher Beams, Push Webhook

Check warning on line 67 in content/docs/platform/additional-resources/glossary.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

content/docs/platform/additional-resources/glossary.mdx#L67

Did you really mean 'Pushpad'?
- Inbox: React component, Angular component, Vue component, Web component, iFrame embed, Custom styling, Headless Inbox

### Step Filter

Step filters customize workflow by specifying notification criteria, enhancing communication efficiency.

### Subscribers

Subscribers are entities designated to receive the notifications you send. Each subscriber in Novu is uniquely identified by their `subscriberId`.

Check warning on line 76 in content/docs/platform/additional-resources/glossary.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

content/docs/platform/additional-resources/glossary.mdx#L76

Did you really mean 'Novu'?

### Team members

Members of a team have access to the Novu web dashboard. This allows you to have individuals work on and manage templates and notifications.

Check warning on line 80 in content/docs/platform/additional-resources/glossary.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

content/docs/platform/additional-resources/glossary.mdx#L80

Did you really mean 'Novu'?

### Layouts
### Topics

Layouts are HTML designs or structures to wrap the content of email notifications. Layouts can be manipulated and assigned to new or existing workflows within the Novu platform.
Topics facilitate bulk notifications to multiple subscribers simultaneously, streamlining communication.

### Workflow

Workflow templates define the flow of messages sent to subscribers.
Loading