Skip to content
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

Update the Notification documentation to introduce the placeholder keywords. #1951

Open
wants to merge 33 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
8840491
#545 Mention customizability in the introduction
Ahmed-Ghanam Dec 6, 2024
714df21
Improve the features explanation
Ahmed-Ghanam Dec 17, 2024
e732bf9
Duplicate the same features explanation for NO
Ahmed-Ghanam Dec 17, 2024
820ae40
Improve the Altinn App Integration section
Ahmed-Ghanam Dec 17, 2024
7380291
Improve the Service Owner System Integration
Ahmed-Ghanam Dec 17, 2024
7d4829b
Improve the Terminology page
Ahmed-Ghanam Dec 17, 2024
e804694
Improve a text
Ahmed-Ghanam Dec 17, 2024
c08da6b
Explain the new keywords and fix typos.
Ahmed-Ghanam Dec 18, 2024
68cbe59
Update the SMS documentation and fix typos
Ahmed-Ghanam Dec 18, 2024
4b670e5
Fix mismatch in text
Ahmed-Ghanam Dec 19, 2024
fe0135b
Improve the send notification documentation
Ahmed-Ghanam Dec 19, 2024
a5b8798
Improve a sentence
Ahmed-Ghanam Dec 19, 2024
b65c345
Improve the order cancelling documentation
Ahmed-Ghanam Dec 19, 2024
040c5fc
Improve a phrase
Ahmed-Ghanam Dec 19, 2024
1343f1c
Improve the email retrieval documentation
Ahmed-Ghanam Dec 19, 2024
9239689
Extend the documentation
Ahmed-Ghanam Dec 19, 2024
4e98f44
Improve the documentation
Ahmed-Ghanam Dec 19, 2024
216208a
Improve a sentence and an example
Ahmed-Ghanam Dec 19, 2024
ba8a7cf
Improve order status documentation
Ahmed-Ghanam Dec 19, 2024
a8ad887
Update get SMS notifications document
Ahmed-Ghanam Dec 20, 2024
7317e0f
Improve two phrases.
Ahmed-Ghanam Dec 20, 2024
b3f6e16
Update a text
Ahmed-Ghanam Dec 20, 2024
6587f2f
Remove a line
Ahmed-Ghanam Dec 20, 2024
5ed1044
Use SMS instead of sms
Ahmed-Ghanam Dec 20, 2024
9319805
Use SMS instead of sms
Ahmed-Ghanam Dec 20, 2024
6894fc8
Replace sms with SMS
Ahmed-Ghanam Dec 20, 2024
6c9d83d
Enhance address lookup documentation
Ahmed-Ghanam Dec 23, 2024
25ef4c6
Improve the Recipient lookup documentation
Ahmed-Ghanam Dec 23, 2024
2f1e33e
Improve the SendCondition documentation
Ahmed-Ghanam Dec 23, 2024
d38dd62
Highlight parts of the example
Ahmed-Ghanam Dec 23, 2024
3f0303c
Highlight parts of code
Ahmed-Ghanam Dec 23, 2024
8d6597d
Update a GUID
Ahmed-Ghanam Dec 23, 2024
9c2cb70
Merge branch 'master' into feature/545-placeholder-keywords
Ahmed-Ghanam Dec 23, 2024
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
55 changes: 30 additions & 25 deletions content/notifications/about/_index.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,59 +6,64 @@ aliases:
weight: 10
---

Altinn Notifications is a service that enables efficient communication with end users through various channels. We offer:
**Altinn Notifications** is a service designed to facilitate efficient communication with end users through various channels. Key features include:

- A robust API for sending notifications via email and SMS.
- Integration with Altinn's existing services to ensure seamless communication.
- Lookup of contact details in national registries using national identification numbers or organization numbers, ensuring that current information is used.
- Seamless integration with Altinn's services to streamline communication workflows.
- Real-time lookup of names and contact details from national registries using national identification numbers or organization numbers, ensuring using up-to-date information.

## Capabilities

**Email Notifications**: Send informational and formatted emails to users.
**Email Notifications**: Send customized, formatted and informative emails directly to users.

**SMS Notifications**: Send concise and timely messages to users' mobile phones.
**SMS Notifications**: Send customized, concise and timely messages to users mobile devices.

**Contact Details Lookup**: Retrieve updated contact details from national registries.
**Name Lookup**: Retrieve current names from national registries.

**Contact Details Lookup**: Retrieve updated contact information from national registries.

## How It Works
Integrate your internal services and Altinn applications with Altinn Notifications
to enable notifications based on specific events or conditions.
Altinn Notifications enables integration with internal services and Altinn applications to send notifications triggered by specific events or conditions.

### API Access
Developers can use the Altinn Notifications API to send notifications and track delivery status programmatically.

Developers can use the Altinn Notifications API to send notifications programmatically and track their delivery status.

### Integration with Altinn Services
Altinn Notifications uses:
- **Register**: Retrieves contact details for businesses.
- **Profile**: Retrieves contact details for end users.

Altinn Notifications leverages the following Altinn services:

- **Register**: Retrieves names and contact details for businesses.
- **Profile**: Retrieves names and contact details for individual users.
- **Resource Registry**: Identifies authorized recipients within an organization.
- **Authorization**: Ensures secure and compliant communication.

### Communication Providers
Altinn Notifications utilizes the following providers:

- **Email**: Azure Communication Services.
Altinn Notifications uses these providers to send messages:

- **Email**: Azure Communication Services.
- **SMS**: LinkMobility.

## Eligible Users
The following parties can send messages via Altinn Notifications, provided they have authorization through Maskinporten:

- Registered service owners
- Altinn Apps
- Internal Altinn services
The following entities can send messages via Altinn Notifications, provided they are authorized through Maskinporten:

- Registered service owners
- Altinn Apps
- Internal Altinn services

## Core Principles

- **Reliability**: Ensures notifications are delivered promptly and accurately.
- **Flexibility**: Supports various notification channels and custom templates.
- **Integration**: Works seamlessly with other Altinn services.
- **Security**: Ensures secure communications in compliance with relevant regulations.
- **Reliability**: Ensures notifications are delivered promptly and accurately.
- **Flexibility**: Supports multiple notification channels and customizable templates.
- **Integration**: Works seamlessly with other Altinn services.
- **Security**: Guarantees secure communication in compliance with regulations.

## Open Source and Collaboration

Altinn Notifications is an open-source project, welcoming community contributions.
Altinn Notifications is an open-source project that welcomes community contributions.

Join our community on GitHub to contribute to the development of Altinn Notifications. Your feedback and contributions help create a robust and reliable notification service.
Join our community on GitHub to participate in the development of Altinn Notifications. Your feedback and contributions are invaluable for building a robust and reliable notification service.

For more information, please refer to our [user guide](/notifications/guides/).
For additional details, please refer to our [user guide](/notifications/guides/).
55 changes: 30 additions & 25 deletions content/notifications/about/_index.nb.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,59 +6,64 @@ aliases:
weight: 10
---

Altinn Notifications is a service that enables efficient communication with end users through various channels. We offer:
**Altinn Notifications** is a service designed to facilitate efficient communication with end users through various channels. Key features include:

- A robust API for sending notifications via email and SMS.
- Integration with Altinn's existing services to ensure seamless communication.
- Lookup of contact details in national registries using national identification numbers or organization numbers, ensuring that current information is used.
- Seamless integration with Altinn's services to streamline communication workflows.
- Real-time lookup of names and contact details from national registries using national identification numbers or organization numbers, ensuring using up-to-date information.

## Capabilities

**Email Notifications**: Send informational and formatted emails to users.
**Email Notifications**: Send customized, formatted and informative emails directly to users.

**SMS Notifications**: Send concise and timely messages to users' mobile phones.
**SMS Notifications**: Send customized, concise and timely messages to users mobile devices.

**Contact Details Lookup**: Retrieve updated contact details from national registries.
**Name Lookup**: Retrieve current names from national registries.

**Contact Details Lookup**: Retrieve updated contact information from national registries.

## How It Works
Integrate your internal services and Altinn applications with Altinn Notifications
to enable notifications based on specific events or conditions.
Altinn Notifications enables integration with internal services and Altinn applications to send notifications triggered by specific events or conditions.

### API Access
Developers can use the Altinn Notifications API to send notifications and track delivery status programmatically.

Developers can use the Altinn Notifications API to send notifications programmatically and track their delivery status.

### Integration with Altinn Services
Altinn Notifications uses:
- **Register**: Retrieves contact details for businesses.
- **Profile**: Retrieves contact details for end users.

Altinn Notifications leverages the following Altinn services:

- **Register**: Retrieves names and contact details for businesses.
- **Profile**: Retrieves names and contact details for individual users.
- **Resource Registry**: Identifies authorized recipients within an organization.
- **Authorization**: Ensures secure and compliant communication.

### Communication Providers
Altinn Notifications utilizes the following providers:

- **Email**: Azure Communication Services.
Altinn Notifications uses these providers to send messages:

- **Email**: Azure Communication Services.
- **SMS**: LinkMobility.

## Eligible Users
The following parties can send messages via Altinn Notifications, provided they have authorization through Maskinporten:

- Registered service owners
- Altinn Apps
- Internal Altinn services
The following entities can send messages via Altinn Notifications, provided they are authorized through Maskinporten:

- Registered service owners
- Altinn Apps
- Internal Altinn services

## Core Principles

- **Reliability**: Ensures notifications are delivered promptly and accurately.
- **Flexibility**: Supports various notification channels and custom templates.
- **Integration**: Works seamlessly with other Altinn services.
- **Security**: Ensures secure communications in compliance with relevant regulations.
- **Reliability**: Ensures notifications are delivered promptly and accurately.
- **Flexibility**: Supports multiple notification channels and customizable templates.
- **Integration**: Works seamlessly with other Altinn services.
- **Security**: Guarantees secure communication in compliance with regulations.

## Open Source and Collaboration

Altinn Notifications is an open-source project, welcoming community contributions.
Altinn Notifications is an open-source project that welcomes community contributions.

Join our community on GitHub to contribute to the development of Altinn Notifications. Your feedback and contributions help create a robust and reliable notification service.
Join our community on GitHub to participate in the development of Altinn Notifications. Your feedback and contributions are invaluable for building a robust and reliable notification service.

For more information, please refer to our [user guide](/notifications/guides/).
For additional details, please refer to our [user guide](/notifications/guides/).
Loading
Loading