Skip to content

Releases: novuhq/novu

v2.3.0

23 Jun 16:03
cb7cb90
Compare
Choose a tag to compare

v2.3.0 (2025-06-23)

API

🚀 Features

  • worker,api-service,dashboard: chat custom webhook provider (#8561)
  • dashboard: Add relative step operators in step conditions fixes NV-6002 (#8541)
  • dashboard: New test workflow drawer fixes NV-6091 (#8521)
  • dashboard,api-service: html editor format code (#8525)
  • api-service: Introduce workflows API fixes NV-5946 (#8275)
  • dashboard: implement V2 template editor with enhanced preview system (#8445)
  • api-service: full liquid parser and variables validation (#8478)
  • api: expose environments CRUD endpoints to external API (#8469)
  • api-service,dashboard: handle editor type change (#8457)
  • api-service,dashboard,application-generic: custom html editor (#8456)
  • api: improve preview context with better error handling and V2 template editor support (#8472)
  • react,js,nextjs,react-native: create new inbox session on subscriber change (#8417)
  • api: add mixpanel tracking for remove branding setting (#8451)
  • api-service: create keyless env creation ff switch (#8448)
  • dashboard: Novu branding fixes & improvements (#8421)
  • dashboard: payload schema management UI (#8315)
  • dashboard,api: email Novu branding (#8413)
  • api,dashboard,web: add 'remove branding' toggle to org settings (#8405)
  • dashboard: add tags, status, and steps filters to workflows page (#8396)
  • add build scripts for pnpm (4c0093dc67)
  • api-service: adjust locale testing groups to v2 (#8388)
  • root: create keyless environment (#8276)
  • api-service: allow email html body control values (#8350)
  • root: upgrade nx to v21.0.4 and update nx.json configuration (#8361)
  • api-service: add data attribute filtering for inbox notifications (#8338)
  • root: feat centralize source of truth of template parser (#8324)
  • api,dashboard: simplify permissions (#8345)

🩹 Fixes

  • dashboard: update LEGACY_DASHBOARD_URL handling and add documentation in .env.example (#8569)
  • api,application-generic: remove workflow and activity feed limits for self-hosted instances (#8564)
  • dashboard: update chat and push provider docs link (#8559)
  • api, worker, webhook, ws, dashboard: switch PM2 mode to single node for open source builds (#8551)
  • api: add missing properties in feed for SDK (#8454)
  • api-service: Make all fields nullable in subscriber response fixes NV-6136 (#8538)
  • api-service: update environment and workflow api summary and description (#8536)
  • root: eslint errors when compiling (#8529)
  • api-service: payload schema defaults apply (#8527)
  • api-service: switching to html editor when preview fails (#8517)
  • shared: allow dots in subscriber IDs for consistent validation (#8514)
  • api: prevent duplicate Novu branding when switching from block to HTML editor (#8497)
  • root: bring back eslint and web app build (#8505)
  • root: upgrade nx to optimum version and this publishes to npm (#8490)
  • root: resurrecting eslint (#8483)
  • api: improve preview error handling and data merging (#8475)
  • novui: broken link on CONTRIBUTION.md (#8466)
  • api: subscription idempotency (#8464)
  • api: add subscription when creating customer (atomicity) (#8458)
  • api: credentials perm check (#8432)
  • root: update nx packages and override path-to-regexp to fix CVE-2024-45296 (#8438)
  • root: update systeminformation to fix vulnerability (#8436)
  • root: upgrade @nestjs/platform-express to resolve multer DoS vulnerability (#8434)
  • root: update tar-fs to resolve security vulnerabilities (#8431)
  • api: branding - multiple body tags (#8423)
  • api-service: optional message tempate id Fixes NV-5983 (#8426)
  • dashboard: Schema review fixes (#8425)
  • shared: remove uneeded AWS s3 env validators (#8039)
  • api-service: modify topic subscriptions api description (#8415)
  • api-service: quota calc (#8395)
  • api: exception filter runtime error (#8408)
  • api-service: data dto for subscriber entity NV-5998 (#8407)
  • react-native: update widget_jwt_expiration_time default value to fix session initialized (#8401)
  • pnpm approved builds (80df2481f6)
  • remove swc core (bdfe1df68e)
  • pnpm 10 repo (65109279ef)
  • api-service: modify client ip retrieval and launch darkly fallback (#8380)
  • api: Update mocha configuration to use SWC instead of ts-node (#8363)
  • api-service: don't require keyless users (1c17b02fa1)
  • bad enum typing (39fd888c14)
  • api-service: modify api summary and add description (#8326)

❤️ Thank You

Dashboard

🚀 Features

  • worker,api-service,dashboard: chat custom webhook provider (#8561)
  • dashboard: removed channel selection screen from the onboarding (#8540)
  • dashboard: Add button for API key regeneration fixes NV-6142 (#8548)
  • dashboard: Add relative step operators in step conditions fixes NV-6002 (#8541)
  • dashboard: layouts page (#8547)
  • dashboard: add schema aware step conditions operators fixes NV-6088 (#8482)
  • dashboard: email editor translation variables (#8524)
  • dashboard: Workflows Page Activity Feed fixes NV-6090 (#8522)
  • dashboard: New test workflow drawer fixes NV-6091 (#8521)
  • dashboard,api-service: html editor format code (#8525)
  • api-service: Introduce workflows API fixes NV-5946 (#8275)
  • dashboard: implement V2 template editor with enhanced preview system (#8445)
  • dashboard: local and scoped variables autocomplete (#8510)
  • dashboard: variable pill understands local variables (#8499)
  • dashboard: fixed eu region by defult issue (#8489)
  • api-service: full liquid parser and variables validation (#8478)
  • dashboard: added cli command to the product onboarding ([#8418](https://github.com/novuhq/novu/pu...
Read more

v2.2.0

20 May 14:09
f804f31
Compare
Choose a tag to compare

🚀 Release v2.2.0 — Upgrade & Dashboard Debut!

We’re thrilled to announce the release of Novu v2.2.0 — a major milestone for the community packed with improvements, performance boosts, and a highly anticipated service debut! 🎉

🆕 Highlights

📊 Dashboard Now Available for Self-Hosted!

For the first time, the Novu Dashboard is now included in the self-hosted setup!
You no longer need to use the older web package — everything is bundled and ready with the new dashboard image:
happy

docker pull ghcr.io/novuhq/novu/dashboard:2.2.0

🔁 Migration Guide from v0 to v2

Upgrading from the older v0 web UI? We’ve got you covered.
Check out our detailed step-by-step guide here:
👉 v0 to v2 Web UI Migration Guide

🛠️ Improvements

  • API and Worker services are now powered by PM2 Cluster Mode, enabling better CPU and resource utilization, especially in high-throughput environments.
  • Numerous bug fixes and stability improvements across all services.
  • Improved logging and error handling to aid in debugging and production monitoring.

📦 Docker Images

docker pull ghcr.io/novuhq/novu/dashboard:2.2.0
docker pull ghcr.io/novuhq/novu/ws:2.2.0
docker pull ghcr.io/novuhq/novu/api:2.2.0
docker pull ghcr.io/novuhq/novu/worker:2.2.0

Thank you to all contributors and community members for your support and feedback.
As always, we welcome your thoughts and bug reports on GitHub or our Discord community.

Happy shipping!
– The Novu Team

v2.1.1

07 Feb 14:49
fc2e5c2
Compare
Choose a tag to compare

This release contains performance improvements and bug fixes.

What's Changed

  • fix(api): make access internal to self-managed bridge by @tatarco in #7145
  • fix(dashboard): In app step form fixes by @desiprisg in #7144
  • feat(dashboard): Sign up Questionnaire by @scopsy in #7114
  • feat(application-generic): add SUBSCRIBER_WIDGET_JWT_EXPIRATION_TIME env variable by @jainpawan21 in #7105
  • chore(api, worker): Instrument workflow v2 controller and bridge use-cases by @rifont in #7150
  • chore(root): Release 2024-11-28 08:06 by @github-actions in #7152
  • fix(api): Resolve circular import issue for workflow update validation by @tatarco in #7151
  • fix(dashboard): Sibling form structure and autosave by @desiprisg in #7149
  • feat(dashboard): saving modal on navigating outside editor by @ChmaraX in #7148
  • feat(dashboard): add feature flags provider and hook by @ChmaraX in #7133
  • perf(api): Lookup subscriber preferences with a single database query by @rifont in #7119
  • chore(root): Release 2024-11-28 20:40 by @github-actions in #7158
  • style(dashboard): Fix all modal and toast text overflow by @rifont in #7155
  • fix(dashboard): Copy current tab snippet code when clicking copy button by @rifont in #7157
  • chore(root): Release 2024-11-29 08:06 by @github-actions in #7162
  • chore(api, worker, dal): remove SubscriberPreferenceRepository by @rifont in #7165
  • fix(api,dashboard): Invalid url error and in-app tabs spacing by @desiprisg in #7167
  • feat(dashboard): Nv 4800 implement arrays and nested forms in custom step controls by @BiswaViraj in #7127
  • chore(shared): Eliminate circular dependencies by @SokratisVidros in #6743
  • fix(dashboard): Truncate workflow name on breadcrumbs by @desiprisg in #7169
  • chore(root): Remove logs by @SokratisVidros in #7168
  • fix(node): add includeInactiveChannels option in sdk method by @jainpawan21 in #7115
  • Revert "fix(node): add includeInactiveChannels option in sdk method" by @SokratisVidros in #7171
  • Fix/get subscriber preference channel update by @SokratisVidros in #7172
  • fix(dashboard): polish autosave experience by @LetItRock in #7164
  • feat(api): fix framework workflow payload preview by @djabarovgeorge in #7137
  • chore(root): Release 2024-12-02 08:06 by @github-actions in #7179
  • fix(dashboard): Update predefined avatars by @desiprisg in #7181
  • fix(api): regression bug by @djabarovgeorge in #7182
  • fix(dashboard): Show failed toast on triggering inactive workflows by @desiprisg in #7183
  • fix(dashboard): Fix custom step controls padding by @desiprisg in #7185
  • fix(api): invalid schema by @djabarovgeorge in #7184
  • chore(root): Release 2024-12-02 15:06 by @github-actions in #7188
  • feat(application-generic): core mixpanel events for the workflow and step creation by @LetItRock in #7189
  • feat(api): wip fix framework workflow issues by @djabarovgeorge in #7147
  • feat(api): converted bulk trigger to use SDK by @tatarco in #7166
  • feat(dashboard): add button loading state prop by @scopsy in #7191
  • chore(root): Release 2024-12-03 08:06 by @github-actions in #7195
  • fix(dashboard): don't use defaultValues for async content by @ChmaraX in #7187
  • fix(dashboard): in-app editor preview only call when tab is opened by @LetItRock in #7186
  • feat(dashboard): signout from v2 should navigatefor new login page by @scopsy in #7196
  • refactor(dashboard): use the update motion library instead of framer-motion by @scopsy in #7193
  • feat(api): gracefully preview by @djabarovgeorge in #7190
  • chore(dashboard): beta label by @LetItRock in #7197
  • chore(root): Release 2024-12-03 10:32 by @github-actions in #7198
  • fix(dashboard): step form values were not updated when switching between steps by @LetItRock in #7201
  • chore(api): Enable preview deployments by @SokratisVidros in #7200
  • fix(js): Remove @novu/shared dependency by @SokratisVidros in #6906
  • feat(dashboard): Getting started page by @scopsy in #7132
  • Revert "fix(js): Remove @novu/shared dependency" by @scopsy in #7206
  • feat(dashboard): Inbox starter onboarding page by @scopsy in #7154
  • fix(api): step naming by @djabarovgeorge in #7140
  • fix(api): next build by @djabarovgeorge in #7217
  • fix(dashboard): minor onboarding updates by @scopsy in #7210
  • feat(api): Nv 4939 e2e testing happy path events by @tatarco in #7208
  • feat(dashboard): Clerk based settings page by @scopsy in #7202
  • feat(dashboard): api keys page by @scopsy in #7204
  • feat(dashboard): Implement email step editor & small preview by @desiprisg in #7129
  • chore(root): Release 2024-12-05 12:46 by @github-actions in #7221
  • feat(dashboard): Add workflow page action menu by @scopsy in #7222
  • feat(dashboard): add plain chat buttons by @jainpawan21 in #7209
  • feat(novu): Add --studio-host option on dev server by @4rthem in #7211
  • feat(dashboard): NV-4969 export to code preview banner by @scopsy in #7224
  • fix(dashboard): dropdown freeze by @scopsy in #7229
  • fix(dashboard): editor fields lagging by @LetItRock in #7213
  • feat(dashboard): add delay step by @ChmaraX in #7131
  • fix(dashboard): Ensure URL Input gets the available width by @SokratisVidros in #7226
  • feat(dashboard): Nv 4525 workflow editor channel preferences by @BiswaViraj in #7212
  • feat(api): add exception log by @djabarovgeorge in #7225
  • fix(dashboard): configurable code-first workflows by @ChmaraX in #7231
  • refactor(api): generate payload in runtime by @djabarovgeorge in #7192
  • chore(root): Release 2024-12-06 15:53 by @github-actions in #7233
  • feat(dashboard): Email step preview by @desiprisg in #7228
  • fix(dashboard): Always trust the URL for the environment selection by @SokratisVidros in #7223
  • fix(dashboard): fixed the missing in-app editor body message by @LetItRock in #7215
  • feat(dashboard): delay amount input field polish by @ChmaraX in #7230
  • style(dashboard): improve keys page design and look and feel by @scopsy in #7236
  • feat(api): 'Missing' issue missing when the control value has empty string by @tatarco in #7244
  • fix(api): allow empty email preview by @djabarovgeorge in #7239
  • chore(root): Release 2024-12-09 08:06 by @github-actions in #7241
  • feat(dashboard): Billing settings page in dashboard v2 by @scopsy in #7203
  • fix(dashboard): run queue invocations safely by @ChmaraX in #7243
  • fix(dashboard): autosave do not block request on validation errors by @LetItRock in #7246
  • fix(dashboard): Fix double separator on step template sheet by @desiprisg in #7247
  • feat(dashboard): Delay step custom controls by @desiprisg in #7242
  • chore(dashboard): Update maily dep by @desiprisg in #7261
  • feat(api): add full step data to workflow dto; refactor by @ChmaraX in #7235
  • fix(dashboard): Fix stale data on test workflow page by @desiprisg in #7245
  • chore(root): specify mongodb version to 8.0.3 by @merrcury in #7258
  • feat(api): revert p...
Read more

v2.1.0

27 Nov 10:50
v2.1.0
0a1e34c
Compare
Choose a tag to compare

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

v2.0.1

11 Nov 12:57
47aa5de
Compare
Choose a tag to compare

What's Changed

Read more

v2.0.0

24 Oct 08:39
f12ef8f
Compare
Choose a tag to compare

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

v0.24.0

18 Mar 09:44
Compare
Choose a tag to compare

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

v0.23.0

09 Feb 17:41
Compare
Choose a tag to compare

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

v0.22.0

14 Dec 10:29
Compare
Choose a tag to compare

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

v0.21.0

07 Nov 11:41
Compare
Choose a tag to compare

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