Skip to content

Releases: novuhq/novu

v0.9.0 - Hacktoberfest Release

10 Nov 13:27
Compare
Choose a tag to compare

Excited to announce our biggest release so far at Novu. This release is the work of our team and over 100 contributors from all around the world. Welcome to version 0.9.0. Let's explore what's new!

Notification Observability

CleanShot 2022-11-10 at 17 58 15@2x

We have overhauled how we store and display the execution of the notification workflow. This change allows much more visibility on the errors or successful execution happening. Here are some of the highlights of the activity feed:

  • Each step workflow can be inspected
  • Execution details for each step are displayed with information and timestamps
  • Inspect raw provider error response
  • Understand delayed and digested events

We hope that this release will provide a ground for improvement and iteration to later support webhook information, etc... Looking forward to hearing your thoughts!

Seen and Read for notification center - Breaking Change

Since our initial launch, we've been asked countless times to provide a true seen functionality and, on top of that, to allow distinguish read from seen.

Currently, we've only had a seen property that was behaving like a read, in this release, we have introduced another property named read and the actual seen behavior is only triggered once the user has seen the notification center.

CleanShot 2022-11-10 at 18 47 36@2x

BREAKING CHANGE
seen behavior has changed to now be modified for when the user sees the notification, and the new read property should be updated on click of the notification.

Testing workflows from the UI

Want quickly to test your new notification template? From now you can easily trigger a notification and specify the payload variable without leaving the template editor.

APNS integration (beta)

Recently we have introduced the Push channel with support for FCM. From this release, you will be able to send notifications using APNS. This integration is still in beta, and we would love to hear your feedback or suggestions.

Subscribers List Page

In this version new subscribers list page was added to inspect your registered subscribers, right now we don't allow creating or editing subscribers. This will be implemented in the upcoming versions.

Integrated provider credentials check

Hearing your feedback for onboarding to Novu, we now test the providers during the integration phase by performing a test email to the provider using the credentials provided. Errors will be displayed inline when you try to integrate.

We hope this will help to identify issues much faster when connecting new providers.
CleanShot 2022-11-10 at 18 52 28@2x

New navigation Spotlight

CleanShot 2022-11-10 at 18 53 57@2x

Scheduled delay notifications

It is now possible to specify a delayed key following the ISO format, and the delay functionality will be delayed until this timestamp. This could be useful to delay the execution of a message until a predefined dynamic date rather than a hardcoded number of minutes or days.

CleanShot 2022-11-10 at 19 10 56@2x

Adding steps in the middle of the workflow

Steps could be now added in the middle between 2 existing nodes in the UI
CleanShot 2022-11-10 at 19 15 01@2x

Other notable changes

  • Regenerating API Keys is now possible by visiting the settings page
  • The novu notification center is available in 45+ new languages! 🌍
  • Novu is now available at the Vercel marketplace, for easier integration with your vercel deployed projects
  • New MS Teams chat provider
  • Various UI and bug fixes resolved (more details in the change list)
  • Documentation improvements
  • Better Kubernetes examples and support
  • Fixed invite link for self-hosted deployments
  • Improved API support in our @novu/node SDK
  • Implemented delivery providers webhook parsing, will be supported fully in next release
  • Higher unit tests coverage for our WEB platform components
  • A lot more!

Changelist

Read more

v0.8.0 - Delay and Step Filters

21 Sep 09:16
Compare
Choose a tag to compare

Exciting news to share with you all! This cycle was a bit shorter because the team was on our very first company offsite, and it was the first time we met in person 😍

Nonetheless, we prepared some of the long-awaited features based on your request. So let's dive in!

Delay Step

Starting with the v0.8.0 release, you will be able to add a new Delay step type that will delay the sending of the next step by the time you specify it too. This is useful if you wish to wait a day or an hour before sending something to the user.

In the next feature, we will also allow passing a dynamic delay timestamp on the API request so you can create reminders and snooze for users based on a dynamic field. Exciting times 🤯 And thanks to our fantastic @ainouzgali, that took ownership of this one.

Step Filters

You can now filter step execution based on the request criteria from subscriber and payload. This can help customize flows for translation and only send specific steps based on subscriber properties such as paying customers, etc...

Kudus to @davidsoderberg 🇸🇪 for making this a reality!

Integration Store Encryption

From this version, all secret credentials on the integration store will be encrypted on the database and decrypted in real time when needed to send an actual request. @djabarovgeorge made sure this feature is backward compatible, but you must add a new secret environment key when upgrading to v0.8.0.

Migration guide

You must pass a STORE_ENCRYPTION_KEY environment variable to your docker-compose .env file. This key should be 32 characters long and stored in a secret store.

Multiple organizations switch on the web

Thanks to @venarius you can now switch between multiple organizations you are part of. Look at the new organization switcher at the left bottom part of the navigation menu 😍

Template variable protection and defaults

One of the most exciting features of this release was done by the one and only @venarius. On the template level, you can make some variables required or provide polyfill values for each.

No more Hello null!

CleanShot 2022-09-20 at 15 55 31@2x

And much more!

New Contributors

Full Changelog: v0.7.3...v0.8.0

v0.7.3 - Small improvements and bug fixes

02 Sep 09:16
Compare
Choose a tag to compare

What's Changed

New Contributors

Full Changelog: v0.7.2...v0.7.3

v0.7.2 - Community Patch Release

30 Aug 17:09
Compare
Choose a tag to compare

A small patch release with work created by the community and our core team.

What's changed

New Contributors

Full Changelog: v0.7.1...v0.7.2

v0.7.0 - Slack, Discord, Push and Subscriber Preferences

21 Aug 14:48
Compare
Choose a tag to compare

This is our biggest release yet, with over 30 contributors and 130 Pull requests with awaited features such as Push, Chat, Subscriber Preference API, API Reference documentation, and more... Let's dive in!

Subscriber Preferences API

From this release, your application notification subscriber will be able to configure their preferences from within the notification center or directly via our API.
image

By default, all existing templates prior to 0.7.0 will be marked as critical and will be excluded from the preference list. To add them, go to the template editor page and un-mark the critical template from the preference defaults.

New templates created after this release will be added to the preference list, and the user can select from the available channels what to not receive and over which channel.

To read more about Subscriber Preference visit the documentation.

Push notifications with FCM

Excited to share that from now it's possible to send push notifications to mobile devices using FCM. This feature was entirely built by our amazing community members and specifically by @raikasdev 💖.
APNS and other providers' support will be landed in the next release. Looking for other push providers? Create a GitHub issue or contribute directly.

To send over the push channel, deviceTokens should be added to the specified subscribers. To read more about it visit the documentation on subscriber credentials and our FCM guide.

Chat Apps (Slack and Discord)

One of our requested features was to send notifications with chat applications such as Slack and Discord. And now you can! Chat apps could be directly configured from the template editor and delivered using the webhook_url mechanism of the chat providers.

To read more about it, visit our guide.

API Reference documentation

With so many requests by the community members, we just had to do something about it ;) With help from @andrewgolovanov and the entire pixel point team, we are honored to present the first version of our API reference.

Notable changes

New notification center languages

Other improvements

New Contributors

Full Changelog: https://gith...

Read more

0.6.2 - i18n support for notification center

31 Jul 08:27
Compare
Choose a tag to compare

i18n support for notification-center component

It is now possible to translate the notification center UI elements by passing a translation object or a premade translation. More info can be found on the documentation page.

Custom object implementation:

<NovuProvider i18n={{
  // Make sure that the following is a proper 2 letter language code,
  // since this is used by moment.js in order to calculate the relative time for each notification
  lang: "de",
  
  translations: {
    poweredBy: "unterstützt von",
    markAllAsRead: "Alles als gelesen markieren",
    notifications: "Benachrichtigungen",
  },
}}>
</NovuProvider>

Premade languages created by the community:

<NovuProvider i18n={'en'}>
</NovuProvider>

What else has changed

Full Changelog: v0.6.0...v0.6.2

v0.6.0 - Digest Engine & Notification Center Upgrades

24 Jul 15:01
Compare
Choose a tag to compare

Version v0.6.0 introduces so many long-awaited features such as: Digest Engine, multi-tab support on notification center, notifications actions and so many other improvements and bug fixes. This release is the hard work of more 16 individual contributors and collaborators that made this version possible.

Digest Engine

The digest engine collects multiple trigger events and aggregates them into a single message delivered to the subscriber in form of an email, ,in-app notification or any other supported novu channel.

This becomes useful when a user needs to be notified on a large number of triggers, and you want to avoid sending too many notifications. Novu will automatically batch the incoming trigger events based on the subscriberId and an optional digestKey that can be added to control the digestion of the events.

Here is an overview of the digest flow, including both supported strategies: Regular and Backoff.

image

To learn more about the digest engine and the additional strategies and usage guide, visit our docs page here.

Notification Actions

Now, creating an even richer experience with the novu notification center is possible, and adding action buttons to a dedicated notification template. Subscribers can make interactions such as accepting invites or friend requests from the notification center without navigating to a different URL.

CleanShot 2022-07-24 at 15 14 57@2x

Multiple notification feeds

It is now possible to configure multiple feed configurations for various notification center templates. The feeds created can be used to fetch notifications for each feed separately. This can help to achieve a multi-tab experience for subscribers depending on the actual use-cases.

CleanShot 2022-07-24 at 15 19 49@2x

New delivery providers

System sync for dark and light modes

Thanks to @FidalMathew you can now choose to sync your theme preference for you system, or select light & dark modes which will be persistent across browser refreshes.

New Go-lang SDK

Created by our amazing community member @samsoft00 you can now interact with Novu using the new go-lang SDK. Info can be found here: https://github.com/novuhq/go-novu

Other notable changes

New Contributors

Full Changelog: v0.5.1...v0.6.0

v0.5.1 - UI/UX improvements and bug fixes

28 Jun 09:35
Compare
Choose a tag to compare

This minor release brings some UI and UX improvements to the notification workflow editor and some bug fixes.

Upsert subscriber on event trigger

Previously when a subscriber was created using the trigger.event method, we wouldn't update it's details with new information brought from the to object when another triggered was performed. This caused multiple users not to receive an email or SMS due to invalid email saved originally on the subscriber.

Now the subscriber entity will be updated upon delivery.

Bug Fixes

When importing the @novu/notification-center using the method suggested in docs an error was received:

Uncaught TypeError: Cannot read properties of undefined (reading 'unseenBadge')

This is now fixed.

What else Changed

New Contributors

Full Changelog: v0.5.0...v0.5.1

v0.5.0 - ⭐ New workflow engine and UI Editor

26 Jun 10:48
Compare
Choose a tag to compare

Extremly excited to anounce our latest release which includes an entire redesign of our trigger engine, a brand new and shining workflow editor on the web management platform, notification center theme customization, and a lot more goodies! Let's check it out:

Redesigned backend trigger engine

To support a more complex Novu usecase with custom flows and events we had to reimagine how our trigger engine works, instead of processing just the hardcoded configuration of delivery a user can now specify a tree-like flow with a custom order of nodes. This infra change will help us to support the upcoming: Digest, Delay, Decision trees, and more.

Job Workflow

In this change, we also introduced BullMQ to manage or step execution Queue to support better persistency and scalability as it will allow us to scale trigger processing across multiple machines in the next upcoming releases.

Redesigned Notification Template Editor

One of the biggest steps to support our future plans is the redesigned Workflow Editor when editing a notification template. Previously, you could only decide on a channel but couldn't control more than one message of this particular channel, and couldn't control the order of execution.

Introducing the new workflow editor powered by React-Flow:
CleanShot 2022-06-24 at 09 31 06@2x

This new workflow will be the basis of more exciting features we are about to release in the upcoming weeks!

Attachment support on email providers

Thank to our amazing contributor @devblin, it is possible to send attachments with your emails. You can easily add attachments using the following API:

import { Novu } from '@novu/node';

const novu = new Novu(process.env.NOVU_API_KEY);

novu.trigger('event-name', {
  to: {
    subscriberId: '...'
  },
  payload: {
    attachments: [{
      file: fs.readFileSync(__dirname + '/data/test.jpeg'),
      name: 'test.jpeg',
      mime: 'image/jpg'
    }]
  }
})

Notification center theme customization

Based on a lot of your requests, it is possible now to customize the notification center component visuals for in our React component. Here is how you can do that:

const theme = {
   dark: {
      // Dark Theme Props
   },
   light: {
       // Light Theme Props
   },
   common: {
      // Common
   }
};

return (
   <PopoverNotificationCenter theme={theme}>
   </PopoverNotificationCenter>
);

For more information about the different parts of the theme configuration:

export interface INovuTheme {
  layout?: IThemeLayout;
  header?: IThemeHeader;
  popover?: IThemePopover;
  notificationItem?: IThemeNotificationListItem;
  footer?: IThemeFooter;
  loaderColor?: string;
  unseenBadge?: IThemeUnseenBadge;
}

export interface IThemeLayout {
  background?: string;
  boxShadow?: string;
  borderRadius?: string;
  wrapper?: {
    secondaryFontColor?: string;
  };
}

export interface IThemeHeader {
  badgeColor?: string;
  badgeTextColor?: string;
  fontColor?: string;
}

export interface IThemePopover {
  arrowColor?: string;
}

export interface IThemeNotificationListItem {
  seen?: {
    fontColor?: string;
    background?: string;
    timeMarkFontColor?: string;
  };
  unseen?: {
    fontColor?: string;
    background?: string;
    boxShadow?: string;
    notificationItemBeforeBrandColor?: string;
    timeMarkFontColor?: string;
  };
}

export interface IThemeFooter {
  logoTextColor?: string;
  logoPrefixFontColor?: string;
}

export interface IThemeUnseenBadge {
  color?: {
    fillColor?: string | ISvgStopColor;
    borderColor?: string;
  };
}

More changes and improvements

New Contributors

Full Changelog: v0.4.2...v0.5.0

v0.5.0-alpha.0

21 Jun 10:04
Compare
Choose a tag to compare
v0.5.0-alpha.0 Pre-release
Pre-release
v0.5.0-alpha.0