Skip to content

Releases: novuhq/novu

v2.1.0

27 Nov 10:50
@rifont rifont
v2.1.0
This tag was signed with the committer’s verified signature.
rifont Richard Fontein
GPG key ID: 096CB015D24168CB
Learn about vigilant mode.
0a1e34c
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Learn about vigilant mode.
Compare
Choose a tag to compare
v2.1.0 Latest
Latest

What’s new in Novu 2.1.0?

TL;DR: Preferences remodelling for 70% improvement in performance of Preference retrieval with an important database migration, 46% reduction in Docker image sizes, and more.

2.1.0 Release Updates

We're excited to share updated focussed on improving database and operational performance in our latest release. Join us as we reveal the improvements our team have been working on!

Preference remodelling and optimization

  • All Workflow & Subscriber preferences are now stored in a central Preferences collection to streamline preference retrieval for the <Inbox /> + Subscriber Preference API for a more performance subscriber preference management experience, and performance improvements of Worker engine during notification delivery
  • IMPORTANT: A mandatory database migration is required with this release to prepare for the removal of the SubscriberPreference collection and the NotificationTemplateRepository.{preferenceSettings,critical} property in a subsequent release. This data is migrated to a centralized Preference collection. Please visit the Data Migration documentation for more information on running the migration script. The following migration of data takes place:
    • Workflow preference (NotificationTemplate.preferenceSettings)
      • -> Preference record with type: 'WORKFLOW_RESOURCE' (for Code-First workflow support)
      • -> Preference record with type: 'USER_WORKFLOW' (for Dashboard/API user preference support)
    • Subscriber Global preference (SubscriberPreference with level: 'GLOBAL')
      • -> Preference record with type: 'SUBSCRIBER_GLOBAL'
    • Subscriber Workflow preference (SubscriberPreference with level: 'TEMPLATE')
      • -> Preference record with type: 'SUBSCRIBER_WORKFLOW'

Docker Image optimization for all applications

  • 46% reduction in Docker image sizes
  • Simplified COPY and RUN commands
  • Overall optimization of image structure
  • Replace external PM2 dependency for graceful shutdowns with native NestJS shutdown module

What's Changed

  • perf(framework): Replace all computed property keys with static declarations by @rifont in #6926
  • chore(web): shorten the digest default duration by @djabarovgeorge in #6918
  • feat(web,dashboard): opt-out, redirects by @ChmaraX in #6922
  • fix(dashboard): Render bold markdown in in app preview by @desiprisg in #6928
  • fix(dashboard): Add default values to workflow editor provider form by @desiprisg in #6932
  • fix(dal): Reduce default Mongo connections by @SokratisVidros in #6901
  • refactor(shared, dal, application-generic, api, web, dashboard): Remove json-schema-to-ts dependency and use JsonSchemaDto everywhere by @rifont in #6921
  • fix(dashboard): promote toast env name by @ChmaraX in #6933
  • fix(dashboard): create workflow docs link by @ChmaraX in #6936
  • fix(dashboard): align heading with the gutter by @ChmaraX in #6935
  • fix(web, dashboard): Remove additional quotes in PHP code snippet by @rifont in #6938
  • feat(api): invalidate stale workflows by @djabarovgeorge in #6887
  • fix(framework): Ensure missing schemas return unknown record type by @rifont in #6912
  • feat(dashboard): Add origin prop to CustomStepControls for conditiona… by @BiswaViraj in #6939
  • chore(root): Release 2024-11-12 08:05 by @github-actions in #6947
  • feat(dashboard): add full utc date for updated at on hover by @djabarovgeorge in #6948
  • fix(dashboard): Dropdown border and action picker clickable area by @desiprisg in #6944
  • fix(dashboard): Trim tag input tags before adding by @desiprisg in #6942
  • fix(dashboard): Allow newlines on trigger workflow payload editor by @desiprisg in #6941
  • fix(dashboard): Align header heights by @desiprisg in #6940
  • feat(api): Billing alerts on usage emails by @scopsy in #6883
  • fix(dashboard): Fix tag input suggestion sorting by @desiprisg in #6943
  • feat(dashboard): unify success toasts by @ChmaraX in #6937
  • fix(dashboard): opt-in image source by @ChmaraX in #6949
  • feat(web,dashboard): opt-in/out tracking by @ChmaraX in #6930
  • feat(api): restrict tags to max 8 by @djabarovgeorge in #6929
  • chore(root): move selective actions to blacksmith by @blacksmith-sh in #6950
  • fix(dashboard): Nv 4679 visiting UI based workflow shows framework code by @BiswaViraj in #6951
  • feat(api): Fix previous steps by @tatarco in #6905
  • fix(dashboard): Show consistent tag inputs by @desiprisg in #6960
  • fix(dashboard): Fix configure action not opening by @desiprisg in #6965
  • feat(dashboard): unify clerk primary button with dashboard design by @ChmaraX in #6959
  • feat(dashboard): trigger test workflow loading state by @ChmaraX in #6961
  • feat(dashboard): autofocus on first create workflow input by @ChmaraX in #6962
  • feat(dashboard): align layout based on design by @ChmaraX in #6964
  • feat(dashboard): workflow list empty states by @ChmaraX in #6955
  • chore(framework, shared, nextjs): Release new versions by @rifont in #6963
  • fix(dashboard): Don't suggest added tags in tag input by @desiprisg in #6968
  • feat(dashboard): workflow editor error handling by @LetItRock in #6953
  • feat(api): add origin backward compatibility mapping by @djabarovgeorge in #6973
  • feat(dashboard): in-app editor unsaved changes modal plus handling esc and clicking on drawer gray overlay by @LetItRock in #6958
  • refactor(api): Use UpdatePreference use-case for all Subscriber Preference updates by @rifont in #6889
  • chore(dashboard): disable 1password on the workflow create sidebar by @LetItRock in #6975
  • fix(api): upsert preference if exist by @djabarovgeorge in #6970
  • feat(dashboard): page meta, gtm, and uptime by @LetItRock in #6974
  • feat(dashboard): styling for read-only input fields by @ChmaraX in #6967
  • fix(dashboard): Tweak Create Workflow copywriting by @desiprisg in #6971
  • fix(dashboard): Workflow saving status on toast and multiple toasts by @desiprisg in #6972
  • refactor(api): remove $or query for hash on env by @scopsy in #6969
  • chore(dashboard): batch of small fixes by @LetItRock in #6977
  • fix(api): fix deletion of issues from persistence once no issues are found by @tatarco in #6956
  • fix(web): Preserve last active organization across full page reloads by @SokratisVidros in #6978
  • feat(node): add deleteByTransactionId method by @jainpawan21 in #6980
  • refactor(worker): Remove redundant Bridge error handling by @rifont in #6875
  • chore(dashboard): a few more fixes by @LetItRock in #6985
  • feat(api): add tags issues by @djabarovgeorge in #6957
  • feat(framework): Expose Workflow resource type in public API by @rifont in #6983
  • chore(dashboard): revert trigger success toast by @LetItRock in #6987
  • fix(api, application-generic): Filter with supplied tags when fetching subscriber preferences by @rifont in #6991
  • chore(framework): Release version 2.5.0 by @rifont in #6988
  • chore(root): Release 2024-11-14 08:06 by @github-actions in #6993
  • chore(root): Release 2024-11-13 08:05 by @github-actions in #6981
  • feat(dashboard): Save workflow on blur by @desiprisg in #6990
  • fix(dashboard): Call save before instantly flushing and instantly save tag changes by @desiprisg in #6997
  • feat(dashboard): Selected route background color in sidebar by @desiprisg in #6996
  • fix(dashboard): Fix close icon padding in tag input by @desiprisg in #6995
  • fix(dashboard): Hide search workflow input by @desiprisg in #6998
  • fix(dashboard): Lighten the focus border on inputs by @desiprisg in https://github.com/novuhq/novu...
Read more

Contributors

SokratisVidros, LetItRock, and 10 other contributors
Assets 2
Loading

v2.0.1

11 Nov 12:57
@merrcury merrcury
v2.0.1
47aa5de
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Learn about vigilant mode.
Compare
Choose a tag to compare
v2.0.1

What's Changed

Read more

Contributors

SokratisVidros, elmdecoste, and 16 other contributors
Assets 2
Loading

v2.0.0

24 Oct 08:39
@merrcury merrcury
v2.0.0
f12ef8f
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Learn about vigilant mode.
Compare
Choose a tag to compare
v2.0.0

What’s new in Novu 2.0.0?

TL;DR: All you need to know about the latest Novu 2.0.0 release. @novu/framework and novu CLI release for code-first workflows, React-based inbox component @novu/react and headless Inbox component @novu/js release.

2.0.0 Release Updates

We're excited to share the new features in our latest release. Join us as we reveal the cool things our team have been working on!

@novu/framework typescript SDK to build code-first workflows

novu CLI to run local studio, generate boilerplate code and sync the workflows

  • Use npx novu@latest init command to create new project having @novu/framework based workflows
  • Use npx novu@latest dev command to start the local studio, generate tunnel URL
  • Use npx novu@latest sync command to sync workflows with novu cloud or self hosted environment
  • Read more on the npm page how to use novu cli and supported flags with each command

What's Changed

Read more

Contributors

SokratisVidros, FlacorLopes, and 37 other contributors
Assets 2
Loading

v0.24.0

18 Mar 09:44
@LetItRock LetItRock
v0.24.0
5d584be
Compare
Choose a tag to compare
v0.24.0

What’s new in Novu 0.24?

TL;DR: All you need to know about the latest Novu 0.24.0 release. Translation management improvements, notifire package deprecations, template editing preview updates, workflow pagination, and more!

0.24 Release Updates

We're excited to highlight the newest features introduced in our latest release. Join us as we explore the treasure that was recovered from the depths of the engineers' dungeon!

giphy (9)

Translation Management Improvements

We’ve made significant enhancements to the Translation management feature.

  • Users can now preview translated templates in their preferred languages in the workflow editor.
  • A new drag-and-drop functionality for uploading of the translation files.
  • We revamped the UI of the step editors significantly enhancing the user experience for template editing.
  • Translation Managements Variants Preview

image

image

image

image

image

image

💡 Note: This feature is only available for Novu Cloud for Business and Enterprise Clients.

Deprecation of Original Notifire Packages

As of this release we will be deprecating the original Notifire packages hosted on GitHub and any package within the @notifire namespace on NPM.

Users should promptly transition to the official @novu packages and platform.

Deprecated Packages

  1. Notifire WebSocket Package (notifire/ws)
  2. Notifire Widget Package (notifire/widget)
  3. Notifire SDK Package (notifire/sdk)
  4. Notifire Web Package (notifire/web)
  5. Notifire API Package (notifire/api)

Workflow Page Pagination Improvements

We've implemented enhanced pagination on the Workflows page, allowing for easier navigation between pages, displaying more items, and direct access to specific pages.

image

Auto Remove Deleted Subscribers from Topic

Previously, deleted subscribers remained part of the topics they were added to. Now, they are automatically removed from any topics they were part of upon deletion.

PR for Reference: #5187

Subscriber Details Now Available For Digest Filters

There was a known reported bug where a subscriber filter on a digest step fails because subscriber details always appeared to be null when evaluating filters on digests.

The bug has been resolved, and subscriber details are now consistently available for digest filters.

PR for Reference: #5234

Notable changes

What's Changed

Read more

Contributors

MasonD, LetItRock, and 11 other contributors
Assets 2
Loading

v0.23.0

09 Feb 17:41
@LetItRock LetItRock
v0.23.0
08bd426
Compare
Choose a tag to compare
v0.23.0

What’s new in Novu 0.23?

TL;DR: All you need to know about the latest Novu 0.23.0 release. Translation management, provider integrations, notification center updates, performance updates, and more!

0.23 Release Updates

We're excited to highlight the newest features introduced in our latest release. Join us as we explore what awaits you!

giphy (7)

Translation Management

💡Note: This feature is only available for Novu Cloud for Business and Enterprise Clients.

The translation management feature allows users to create, upload, and edit translation groups and files from the Novu dashboard.

It’s new and we’re excited for you to start using it in your apps!

With this feature comes a new handlebar helper for translations, {{ i18n ... }}. Novu users can now translate their notification templates to different languages using the i18n handlebar helper and the translation keys in the editor.

image

Support for Non-Root User (UID 1000)

In our continued effort to enhance security and compatibility in enterprise environments, we are proud to announce a significant update aimed at supporting systems with restricted root access.

Key Features:

  • Non-Root User Support: Novu now officially supports deployment under a non-root user with a fixed UID of 1000. This update is crucial for enterprise deployments on systems that enforce strict no-root policies, ensuring compliance with security best practices.
  • Seamless Integration: This enhancement facilitates smoother integration of Novu into secure environments, reducing the need for workarounds or exceptions in security policies.
  • Enhanced Security: Running Novu under a non-root user reduces potential security risks and aligns with the principle of least privilege, further safeguarding our notification infrastructure.

Getting Started:

No action is required from your side to take advantage of this update. The changes have been seamlessly integrated into Novu, ensuring that your enterprise deployments comply with non-root user policies without any additional configuration needed.

ARM Image Support

We're thrilled to share that Novu has officially introduced support for ARM images, marking a significant step in our dedication to embracing innovation and responsibility within the tech landscape. This development ensures that Novu stays ahead in the realm of notification infrastructure by broadening our platform's accessibility, compatibility, and sustainability.

Key Highlights:

  • ARM Architecture Support: Users can now deploy Novu on systems powered by ARM processors, benefiting from the efficiency and performance improvements that ARM architectures offer.
  • Optimized Performance: ARM support brings optimized performance for ARM-based deployments, ensuring faster and more efficient notification processing.

Getting Started with ARM Images:

To use Novu on an ARM-based system, simply pull the ARM-compatible Docker image from our registry. If you are on a not a ARM based system you can use the following command in docker to pull the image.

docker pull --platform linux/arm64 ghcr.io/novuhq/novu:v0.23.0

💡Note: Emulating ARM hardware may be slower then running an ARM image on ARM hardware.

Deprecation of Original Notifire Packages

Novu has evolved so much from when it was originally created. On the release of v0.24.0, we will be deprecating the original Notifire packages hosted on GitHub and any package within the @notifire namespace on NPM.

The following packages hosted on GitHub under the novuhq organization are scheduled for deprecation:

Deprecated Packages

  1. Notifire WebSocket Package (notifire/ws)
  2. Notifire Widget Package (notifire/widget)
  3. Notifire SDK Package (notifire/sdk)
  4. Notifire Web Package (notifire/web)
  5. Notifire API Package (notifire/api)

NPM Namespace Deprecation

All packages within the @notifire namespace on NPM are also scheduled for deprecation. This includes any package prefixed with @notifire/, ensuring a comprehensive and clear transition away from these older offerings.

Users currently relying on these deprecated packages should promptly transition to the official @novu packages.

Field-level Encryption to API Keys

We're security conscious at Novu. The API keys are now encrypted at rest in the database and hashed at rest in the cache.

We added this security feature to prevent direct use of the API key in the event of a database breach or bad actor trying to use the key with bad intentions.

Note: All existing API keys become encrypted through a data migration script for self-hosted users. Running the script more than once does not re-encrypt the api keys.

Bulk Delete Notifications in Notification Center

Users can now remove multiple notifications using an array of message ids (limit of 100) via the Notification center hooks and Headless library.

Notification Center Hook

const onSuccess = (data: IMessage) => {};

const onError = (error: Error) => {};

const { removeNotifications, isLoading, isError, error } = useRemoveNotifications({
  onSuccess,
  onError,
});

Headless Service

headlessService.removeNotifications({
  listener: (
    result: UpdateResult<IMessage, unknown, { messageId: string }>
  ) => {
    console.log(result);
  },
  onSuccess: (message: IMessage) => {
    console.log(message);
  },
  onError: (error: unknown) => {
    console.error(error);
  },
  messageIds: ["message_id_1", "message_id_2" ],
});

Rocket Chat Provider Integration

You can now send Chat messages via the Rocket Chat provider integration:

Brevo (SendInBlue) SMS Provider Integration

You can now send SMS messages via the Brevo SMS provider integration:

iSend SMS Provider Integration

You can now send SMS via the iSend sms provider integration:

CustomData Overrides for SMS

A customData overrides provider for SMS now exists. This property allows us to support provider specific configurations in future for SMS providers.

For now, it only supports DLT (Distributed Ledger Technology) for the Gupshup SMS provider.

Trigger workflow with customData

novu.trigger("gupshup-workflow", {
  to: {
    subscriberId: "1234",
  },
  payload: {
    user: "Viraj",
  },
  overrides: {
    sms: {
      customData: {
        principalEntityId: "principal entity Id",
        dltTemplateId: "dlt template Id",
      },
    },
  },
});

Email Editor Variables Auto-suggestion Dropdown

We've made a little adjustment to the workflow email editor to enhance user experience by including auto-suggestions while adding variables.

This feature greatly minimizes the chance of selecting the wrong variable and having incorrect template content.

Notable changes

What's Changed

  • Update Novu to Node 18 LTS by @raikasdev in #4014
  • docs(providers): Clickatell documentation incorrectly shows TwilioSmsProvider by @jacques in #4897
  • fix(web): Intercom chat bubble should not show after closing integrat… by @PaperBoardOfficial in #4951
  • fix(fcm): do not mutate overrides object by @strangeAeon in #4866
  • fix(api): logo extension and type should be validated on branding endpoint by @sco...
Read more

Contributors

jacques, PaulFasola, and 26 other contributors
Assets 2
Loading

v0.22.0

14 Dec 10:29
@LetItRock LetItRock
v0.22.0
c8bec33
Compare
Choose a tag to compare
v0.22.0

What’s new in Novu 0.22?

TL;DR: All you need to know about the latest Novu 0.22.0 release. Multi-tenancy Variants, API Idempotency, API Rate Limiting, Filter conditional variables and more!

0.22 Release Updates

We're excited to highlight the newest features introduced in our latest release. Join us as we explore what awaits you!

image

Multi-tenancy Variants

Variants is an integral component of our multi-tenancy feature and aims to empower users to create multiple variants for a given workflow step, such as the Email step. These step variations are linked to specific conditions.

Within the multi-tenancy context, these conditions may pertain to tenants; for instance, if the tenant is named "Nike", a specific email variant will be chosen.

However, these conditions extend beyond tenants, allowing users to base their criteria on the trigger payload, subscriber data, or webhook data.

During the notification sending phase, the system’s logic will determine the appropriate variant based on the contextual information that was passed with the trigger event and the conditions applied to the variants. Only a single variant will be selected and sent to the user at the end.

Note: We have renamed the Filters functionality to Conditions.

variants

variants

Adding a variant to email step

In this gif above, we added a variant to our email step, thus making us have the root variant (with no condition) that will be sent if there's no tenant identifier specified, and a variant that will be sent if the tenant identifier is Nike.

Idempotency

To enhance the resilience and dependability of our API system, especially during disruptive scenarios like network interruptions, we have introduced the Idempotency headers to POST and PATCH HTTP methods within the API.

We have now granted users the ability to include Idempotency headers in their requests. A given operation will not be executed more than once, even if users resubmit the request following a perceived failure.

This guarantees that we process changes in a fail-safe manner, and the system caches the response for a day for future reference. This approach ensures that only valid and unique changes are processed, contributing to the overall robustness and reliability of our API system.

Note: Currently, the Idempotency headers are not enabled on the Novu cloud but functionality is available for self-hosting. We are currently integrating it into all of our SDKs as well.

Huge shoutout to @mahendraHegde for bringing in the Idempotency feature and to @michaldziuba03 for implementing the exponential retry mechanism in Node SDK! Your contribution rocks, much appreciated! 🙌

PRs:

API Rate Limiting

Rate limiting is an essential functionality for establishing a robust and resilient system. It safeguards system resources from being misused by malicious actors or being monopolized by one client.

It plays a vital role in sustaining consistent system performance by regulating traffic and preventing sudden increases that could degrade service quality.

Note: It's not currently enabled on Novu Cloud yet. We'll inform all users whenever we want to enable this option for all cloud users. If you're self-hosting, you can enable API rate limiting immediately with the IS_API_RATE_LIMITING_ENABLED flag in the environment variable.

PRs:

  • feat(application-generic, shared): Add Rate Limiting feature flag in #4667
  • feat(dal, shared, api): Add rate limit DAL attributes by @rifont in #4758
  • feat(api, shared): Add use cases to resolve an environment's api rate limit in #4774
  • chore(api, shared, app-generic): Convert API rate limit FF to be LaunchDarkly compatible in #4857
  • feat(api): Add evaluate api rate limit use case in #4844
  • feat(api): Add API rate limiting NestJS guard in #4910
  • feat(api): Apply rate limit decorators to api controllers and methods in #4915
  • feat(api): Add variable-cost token bucket rate limiting algorithm in #4911

Variable Support in the Step Conditions aka Filters

The condition Value field now supports the use of variables as its value, enhancing the dynamic nature of this functionality.

variables_in_step_conditions

PRs:

  • feat: add support for variables in filter values #4724

Workflow Settings Override for tenants

The workflow settings override functionality allows to update the active and channel preferences fields on the workflow per tenant.

A good use case for this is the ability to have the following setting preferences enabled for all users, but you want them disabled for specific tenants. For example, you have about 3 tenants: Nike, Cloudinary and Eden. You can create a new settings override by passing the tenantId and workflowId, and your preferences.

We have implemented the set of the API endpoints that allow the following:

  • Creating, updating and deleting overrides,
  • List all overrides, or for one template.

override1

override2

Create new workflow settings overrides

override3

Update workflow settings overrides

PRs:

  • Stacked PR's of - Workflow override in #4773

Note: We are currently working on ensuring our SDKs have support for this functionality.

Event Cancellation from Digest

We have added a new API endpoint that allows the cancellation of any event from the digest.

digest

Note: We are currently updating all of our SDKs to support this new functionality.

PRs:

  • Feature: Ability to cancel any arbitrary events from digest in #4888

Resiliency and Performance Improvements

We have done some performance plumbing to improve the speed & resilience of the overall system. Our goal is to keep working on performance, reliability and resilience in every release.

Custom SMS Provider Integration

You can now send SMS messages using custom SMS providers using REST API. Do this by setting up the Generic SMS provider:

custom_sms

custom_sms2

MessageBird SMS Provider Integration

You can now send SMS messages via the MessageBird SMS provider integration:

messagebird

BulkSMS Provider Integration

You can now send SMS messages via the BulkSMS SMS provider integration:

bulksms

SimpleTexting SMS Provider Integration

You can now send SMS messages via the SimpleTexting SMS provider integration:

simpletexting

Azure SMS Provider Integration

You can now send SMS messages via the Azure SMS provider integration:

azure_sms

Braze Email Provider Integration

You can now send emails via the Braze Email provider integration:

braze

Pusher Beams Provider Integration

You can now send messages via the Pusher Beams provider integration:

pusher_beams

Grafana On Call Webhook Chat Provider Integration

You can now send messages via the Grafana On Call webhook chat provider integration:

grafana

Notable changes

What's Changed

  • fix(@novu/fcm): use message instead of body for data-type notifications by @cherfia in #4652
  • Updated the name of Twitter to X in all docs by @Arcturus22 in #4662
  • 🐛 Add missing NODE_ENV for web deployment by @sachin-duhan in #4672
  • Enhanced Security Information via Updating [[SECURITY.md](http://security...
Read more

Contributors

collimarco, gitstart, and 44 other contributors
Assets 2
Loading

v0.21.0

07 Nov 11:41
@LetItRock LetItRock
v0.21.0
4228d9c
Compare
Choose a tag to compare
v0.21.0

TL;DR: All you need to know about the latest Novu 0.21.0 release. Removal of the multi-providers feature flag, @novu/notification-center-angular package now supports Angular projects of version 15 and higher, new Actor system variables, Brand Logo Management, Organization APIs and more.

0.21 Release Updates

We're thrilled to announce the newest features in our most recent release. Let's get started and explore what's waiting for you!

giphy_(47)

Removal of the multi-providers Feature Flag

In this release, we are excited to announce the removal of the multi-providers feature flag. This feature was previously disabled by default to ensure backward compatibility.

Action Required for Upgrading

To upgrade to this new version, you will need to follow these steps:

💡 Note: You must change the path for each script individually and run it separately.

  1. Run Migration Script for Creating primary and priority Fields: You can access the migration script for creating primary and priority fields by clicking here.

    // apps/api/package.json

"migration": "cross-env NODE_ENV=local MIGRATION=true ts-node --transpileOnly ./migrations/integration-scheme-update/add-primary-priority-migration.ts",
    cd apps/api
npm run migration

  2. Run Migration Script for Updating Novu Integrations: To update Novu integrations, you'll need to execute the migration script available here.

    // apps/api/package.json

"migration": "cross-env NODE_ENV=local MIGRATION=true ts-node --transpileOnly ./migrations/integration-scheme-update/update-primary-for-disabled-novu-integrations.ts",
    cd apps/api
npm run migration

By following these steps, you can smoothly upgrade to the latest version of our software and enjoy the benefits of the multi-providers feature flag removal. If you encounter any issues during the upgrade process, please don't hesitate to reach out to our support team for assistance.

PR Details:

chore(web): Remove multi-provider feature flag by @rifont in #4402

Notification Center Angular

Starting with this release, the @novu/notification-center-angular package now supports Angular projects of version 15 and higher.

Previously, it had a limitation only for Angular version 15.

PR Details:

feat(notification-center-angular): Support Angular versions 15+ by @rifont in #4518

Actor System Variables

In this release, we've introduced a new Actor system variables.
These system variables can now be utilized within any channel editor, enhancing flexibility and customization.

  • You can now leverage actor system variables in your channel editors.

Screenshot_2023-10-27_at_15 28 34

  • When setting up a "Run a Test" Trigger, the application will prompt the user to provide actor information.

Screenshot_2023-10-27_at_15 29 43

This addition lets you incorporate dynamic actor information in your channel configurations, making your workflows more versatile and adaptable.

PR Details:

feat: add actor to system variables by @ainouzgali in #4278

Brand Logo Management

This release introduces a new functionality that allows you to update or remove your brand logo seamlessly.

  • Update Brand Logo: You can now easily replace your existing brand logo with a new one, giving your application a fresh look.
  • Remove Brand Logo: If you prefer a cleaner interface, you have the option to remove the brand logo altogether.

Screenshot_2023-10-27_at_15 34 27

These brand logo management capabilities give you greater control over your application's visual identity. Customize your branding effortlessly and tailor it to your specific needs.

PR Details:

feat: add ability to remove uploaded brand logo by @michaldziuba03 in #4451

New Provider: Pushpad

We are excited to introduce a new integration with Pushpad in this release.

You can learn more about this provider here.

PR Details:

Screenshot_2023-10-27_at_15 39 53

Organization APIs Enhancement

In this release, we've introduced a significant enhancement - the Organization APIs.
You can now harness the power of these APIs to manage their organizations efficiently, handle member listings, removals, and even update branding seamlessly.

  • Manage Organizations: With the Organization APIs, clients gain full control over their organization's settings and configurations.
  • List and Remove Members: Easily access and manipulate the list of organization members, allowing for efficient membership management.
  • Branding Updates: Organizations can now update their branding effortlessly using these APIs, ensuring consistent and up-to-date branding across the board.
  • Member Invitations: For inviting new members, we've introduced a separate endpoint POST /invites, simplifying the process of expanding your organization.

Screenshot_2023-10-27_at_15 46 40

💡 Note: The SDKs are being updated to handle these new API calls.

PR Details:

Notable changes

  • chore: dependencies security vulnerability fix by @scopsy in #4532
  • Add Trigger Identifier to the Subscriber Preferences response by @djabarovgeorge in #4559
  • fix(api): Cancel all jobs related to a transactionId from the 'cancel' method by @scopsy in #4616

What's Changed

Read more

Contributors

collimarco, renovate, and 30 other contributors
Assets 2
Loading

v0.20.0

24 Oct 08:53
@LetItRock LetItRock
v0.20.0
a09cf80
Compare
Choose a tag to compare
v0.20.0

What’s new in Novu 0.20?

TL;DR: All you need to know about the latest Novu 0.20.0 release. Global User Preferences, Integrations conditions, Digest and delay filters and more!

0.20 Release Updates

We're thrilled to announce the newest features in our most recent release. Let's get started and explore what's waiting for you!

https://dev-to-uploads.s3.amazonaws.com/uploads/articles/1jxs3nc6jp6abbjvis8i.gif

Global Channel Preferences for Subscribers API

It's now possible to set subscriber preferences globally for either a particular channel or all channels via API.

I'm really stoked about this because before now it was only available per workflow, /:subscriberId/preferences/:templateId

With these API URLs, you can fetch and update global subscriber preferences.

  • PATCH /subscribers/:subscriberid/preference - Update a subscriber preference globally.
  • GET /subscribers/:subscriberid/preferences/global - Fetch a subscriber preference globally.

Note: These methods are also available in the NodeJS SDK. They will be available in other language SDKs very soon.

If you're using the Headless service and Notification Center Widgets, you can set or fetch via the following APIs:

  • widgets/preferences - PATCH : Update subscriber preferences globally
{

    "enabled": true,
    "preferences": [
        {
            "type": "in_app",
            "enabled": true
        },
        {
            "type": "email",
            "enabled": false
        }
    ]
}
  • widgets/preferences/global - GET : Fetch subscriber preferences globally.

The exposed methods from the widgets are:

  • fetchUserGlobalPrereferences
  • updateUserGlobalPreferences

Note: If a workflow is marked as critical, the subscriber global preferences will be ignored, and notifications will be sent.

Filters Usage in Digest and Delay Nodes

Users can now add filters to the digest and delay nodes inside the workflow editor to dynamically control if a digest should be used or not.

https://dev-to-uploads.s3.amazonaws.com/uploads/articles/g1l0dao60xd7eixps56r.png

Digest Node: Adding filter

https://dev-to-uploads.s3.amazonaws.com/uploads/articles/8epc6ew33s9accvtmjzm.png

Delay Node: Adding filter

Improved Error Messages In The Workflow Editor

We have improved the error icons and states for each node in the workflow, when no provider is connected or not configured.

SMS & Email Custom Data Overrides

We now support adding custom data in email overrides as shown below:

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

const novu = new Novu('<NOVU_API_KEY>');

await novu.subscribers.trigger("workflowIdentifier", {
  to: "subscriberId",
  payload: {
    customKey: "customValue",
  },
  overrides: {
    email: {
      from: "support@novu.co",
      // customData will work only for sendgrid
      customData: {
        "customKey": "customValue"
      }
    }
  }
}

Email Custom Data overrides

Note: This works for Sendgrid only at the moment.

You can override sms values via the code below.

...
...
await novu.subscribers.trigger("workflowIdentifier", {
  to: "subscriberId",
  payload: {
    customKey: "customValue",
  },
  overrides: {
    sms: {
      to: "<insert-phone-number>",
      content: "<insert-content>"
    }
  }
}

SMS Overrides

Enabling The Addition of Conditions to Integrations

Users can now create conditions for the channel integrations to be executed for specific tenants only.

https://dev-to-uploads.s3.amazonaws.com/uploads/articles/c4j4ioad8tjqljy3qzqx.png

https://dev-to-uploads.s3.amazonaws.com/uploads/articles/o187yxcsmtgfgq7a7gyp.png

In the image above, you can add the condition (to an integration) to state that the integration should be used if the tenant identifier used in trigger matches the tenant identifier set here.

Note: The integrations are the provider instances on the Integration store dashboard.

When Novu runs a trigger code with a tenant Identifier attached to it like so:

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

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

await novu.trigger('<WORKFLOW_TRIGGER_ID>',
  {
    to: {
      subscriberId: '<UNIQUE_SUBSCRIBER_IDENTIFIER>',
      email: 'john@doemail.com',
    },
   tenant: "tenantIdentifier"
  }
);

..Novu runs checks on the integrations in the Integration store to determine which integration matches to be used to send the notification based on any condition that has been set. If nothing was set, it defaults to the primary provider set for the channel used in the workflow.

Mailtrap Email Provider Integration

Now, you can use the Mailtrap Email provider on Novu.

https://dev-to-uploads.s3.amazonaws.com/uploads/articles/fb9pmn5xu3ep6f8lcpq3.png

Clicksend SMS Provider Integration

Now, you can use the Clicksend SMS provider on Novu.

https://dev-to-uploads.s3.amazonaws.com/uploads/articles/1f5154c9alnn4aqollxl.png

All Changes

Read more

Contributors

dmgarland, brianteeman, and 41 other contributors
Assets 2
Loading

v0.19.0

14 Sep 06:47
@scopsy scopsy
v0.19.0
8a10c63
This commit was signed with the committer’s verified signature.
scopsy Dima Grossman
SSH Key Fingerprint: 4HLUMYinPN4W9srELMyDWRxb5dMKVXTx1LBZrtHozMU Learn about vigilant mode.
Compare
Choose a tag to compare
v0.19.0

What’s new in Novu 0.19?

TL;DR: All you need to know about the latest Novu 0.19.0 release. Multi-tenancy management, bulk subscriber creation, override layouts and more!

0.19 Release Updates

We're eager to showcase the latest features in our most recent release. Let's dive in and discover what's in store for you!

giphy (2) (1)

Multi-tenancy Management

We are stoked to let you know that you can now manage tenants from the UI (Novu’s dashboard) and the API.

tenants-management (1)

Self-hosted users need to add and turn on the IS_MULTI_TENANCY_ENABLED env flag to be able to manage tenants in their Novu installation.

Tenants Usage in Workflows as Variables

With tenants feature now generally available, there are different ways you’ll be able to use it in your app depending on your use case.

One of those ways is using it as variables in your workflows and triggers. When triggering a notification using the events trigger endpoint, you can pass in a tenant property as a parameter like so:

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

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

await novu.trigger('<WORKFLOW_TRIGGER_ID>',
  {
    to: {
      subscriberId: '<UNIQUE_SUBSCRIBER_IDENTIFIER>',
      email: 'john@doemail.com',
      firstName: 'John',
      lastName: 'Doe',
    },
    payload: {
      name: "Hello World",
      organization: {
        logo: 'https://happycorp.com/logo.png',
      },
    },
	 actor: "actorId"
   tenant: "tenantIdentifier"
  }
);

passing in tenant property when triggering a notification

The tenant can also be accessed in a workflow template like so:

{{ tenant.data.logo }}

accessing tenant properties in a workflow

Bulk Subscriber Creation

This release also ships the wildly requested “bulk subscriber creation.” Starting v0.19, you’ll be able to create subscribers in bulk (up to 500 at once) using an API endpoint.

Note: The bulk API is limited to 500 subscribers per request.

await novu.subscribers.bulkCreate([
      {
        subscriberId: 'test-subscriber-1',
        email: 'test-user@sd.com',
        firstName: 'subscriber-1',
        lastName: 'test-1',
      },
      {
        subscriberId: 'test-subscriber-2',
        email: 'test-user-2@sd.com',
        firstName: 'subscriber-2',
        lastName: 'test-2',
      },
      {
        subscriberId: 'test-subscriber-3',
      },
    ]);

Addition of Tags in Workflow Settings

We have added the ability to use tags in the workflow settings screen.

This change allows use cases where you need to group multiple workflows under the same tag, and then use it to filter subscriber preferences for example.

taggs-workflow-settings (1)

Allow Override layout On Trigger

To override your assigned layout during a trigger event use the layoutIdentifier property, the layout specified will be used for all emails in the context of that trigger event.

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

const novu = new Novu('<NOVU_API_KEY>');

novu.trigger('workflow-identifier', {
  to: {
    subscriberId: '...',
  },
  payload: {
    attachments: [
      {
        file: fs.readFileSync(__dirname + '/data/test.jpeg'),
        name: 'test.jpeg',
        mime: 'image/jpg',
      },
    ],
  },
  overrides: {
    layoutIdentifier: 'your-layout-identifier',
  },
});

Show Primary Providers on Workflow Nodes

Now you can see the primary provider of a channel in the nodes that show on the workflow editor. This gives you more context and better identification without extra clicks!

Screenshot 2023-09-11 at 16 11 03

Enhanced Workflow Nodes Misconfiguration Error

Nodes and workflows will now display mis-configured workflows on the dashboard like so:

Screenshot 2023-09-11 at 16 20 25

All changes

  • Nv 2474 styles tag css in email is not showing in few email clients by @davidsoderberg in #3978 - We now convert all email styles to inlince CSS for compatibility across browsers
  • fix: so swagger json validates by @davidsoderberg in #3969 - Improved our swagger validation for the API Swagger data
  • Reduce count 1000 to the db by @djabarovgeorge in #3993 - Breaking: For socket events we will return hasMore boolean field incase there are more than 100 results available.
  • feat: add tags for workflow settings by @scopsy in #4065 - Tags could now be added to workflows in the workflow settings page, once added they can be used later for usecases such as filtering the user preferences in the notification center
  • Nv 2517 displays that workflow has nodes that will fail to send a notification by @BiswaViraj in #3966 - Nodes and workflows will now display mis-configured workflows
  • feat: show providers on workflow nodes by @BiswaViraj in #3998 - Providers will be shown on nodes for better identifications
  • feat: add override layout in trigger functionality by @ainouzgali in #3961 - You can now override the default layout using the overrides part of the trigger
  • feat(worker): remove performance svc as it was temporary by @p-fernandez in #3944
  • Docs platform guide handlebars by @sumitsaurabh927 in #3833
  • fix: sidebar intercepting workflow editor by @davidsoderberg in #3968
  • feat(wip): initial bulk subscriber create by @ainouzgali in #3938
  • Nv 2690 add identifier field to layouts scheme by @ainouzgali in #3956
  • feat(ci): reuse instructions to tidy up pipelines by @p-fernandez in #3975
  • feat: migration script to add identifier to layouts by @ainouzgali in #3967
  • feat(ci): separate the swagger validation in own runner plus improvement by @p-fernandez in #3981
  • fix(ci): indenting action by @p-fernandez in #3984
  • patch : remove rows only when steps are truthy by @djabarovgeorge in #3980
  • Update ReadMe to include Java SDK link by @mayorJAY in #3974
  • Add Analytics call to Track Deletion of Templates by @Cliftonz in #3971
  • feat add organization id index in integration by @djabarovgeorge in #3983
  • fix: so add a provider is not displayed in empty state by @davidsoderberg in #3985
  • feat(ci): reusable action to run backend (api, worker) for clients by @p-fernandez in #3991
  • fix(ci): proper settings for secrets for run backend by @p-fernandez in #3992
  • Changed the sidebar position of Python by @bcsamrudh in #3997
  • docs: add nestjs quickstart guide by @michaldziuba03 in #3747
  • fix: remove github discussion link by @jainpawan21 in #4002
  • feat: fix logger error order by @djabarovgeorge in #4003
  • fix: add missing sharable url in the new integration form by @djabarovgeorge in #3986
  • next fix logger error order by @djabarovgeorge in #4006
  • clean patch - execution details no write concern by @djabarovgeorge in #4008
  • optimization : merge two redis calls in api key authenticate by @djabarovgeorge in #3982
  • Fix failing test for web and widget by @scopsy in [https://github.com//pull/4009](https://github.co...
Read more

Contributors

gitstart, davidsoderberg, and 16 other contributors
Assets 2
Loading

v0.18.0

27 Aug 08:08
@scopsy scopsy
v0.18.0
9094f81
This commit was signed with the committer’s verified signature.
scopsy Dima Grossman
SSH Key Fingerprint: 4HLUMYinPN4W9srELMyDWRxb5dMKVXTx1LBZrtHozMU Learn about vigilant mode.
Compare
Choose a tag to compare
v0.18.0

What’s new in Novu 0.18?

TL;DR: All you need to know about the latest Novu 0.18.0 release. General Layout design, multi-provider configuration and more!

0.18 Release Updates

We're excited to unveil the freshest developments in our latest release. Let's plunge right in and uncover what awaits you!

General Layout Design

We have refreshed the layout design to accommodate and provide a foundation for a lot of upcoming future updates regarding the navigation stack and general usability of the system.

Multi-provider Configuration

In the last update, I mentioned that Novu now supports multiple providers.

Now you can specify who should be the primary provider when you have multiple providers for a particular channel for a given environment. As mentioned in the last release, you can programmatically call a provider identifier during a trigger event.

await novu.trigger("<workflow_trigger_id>", {
  to: {...},
  payload: {...},
  overrides: {
    email: { integrationIdentifier: 'the identifier"} ,
    sms: { integrationIdentifier: 'the identifier"}
  }
});

Migration for Self-hosted Novu Users - BREAKING CHANGE

A migration needs to be run prior to the new version update:

cd apps/api
npm run migration:primary-provider

# .env file in apps/api/src/.env should have a MONGO_URL pointing to your deployment

Plunk Email Provider Integration

Now, you can use the Plunk Email provider on Novu.

Screenshot 2023-08-24 at 11 28 47

All changes

New Contributors

Full Changelog: v0.17.2...v0.18.0

Contributors

renovate, davidsoderberg, and 10 other contributors
Assets 2
Loading