Skip to content

chore(docs): update Notification Manager Service documentation #2254

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 15 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -553,6 +553,8 @@ property in the [Users CRUD][crud-users] does not have a value.
If you use an alphanumeric sender ID please avoid generic names (e.g. SMS, Info...), otherwise the SMS provider may return an error like [*Invalid 'From' Number*][twilio-invalid-number]. Please check the [SMS Service documentation][sms-service] for more details about supported providers.
:::

- **email** - `object` (available since version 2.4.4): the configuration for the email channel.
- **escapeNewlines** - `string`: escape newlines characters with \<br\> tag in HTML email templates. Disabled by default, available options are: `enabled`, `disabled` (default).
- **voice** - `object`: the configuration for the outbound calls used for voice notifications.
- **retryCount** - `integer`: the number of retries that can be made until a timeout is reached if the initial call fails to connect.
The default retry count is 0 and the maximum count is 2. Any value higher than 2 will be considered 2.
Expand Down
10 changes: 10 additions & 0 deletions docs/runtime_suite/notification-manager-service/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,16 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [2.4.4] 2025-07-28

### Fixed

- Missing notification handlers now don't cause service failure

### Changed

- Disable by default HTML newline escape introduced with v2.4.0 and add `email.escapeNewlines` configuration option to enable it

## [2.4.3] 2024-12-18

### Fixed
Expand Down