:
Last modified: Feb 6, 2024

Notifications

Description of the notifications capabilities in Altinn 3.

On this page:

This section of the documentation is a work in progress. There are sub sections with missing and/or only partial documentation.

Main benefits

Reasons to consider using Altinn Notifications for communication with Norwegian citizens or businesses

  1. Contact information in national registries can be retrieved at send time based on organisation number or person identification number.
  2. Altinn roles can be used to identify the correct recipients within an organisation.
  3. Notifications can have send conditions related to the state of, or actions performed on, an Altinn App instance
  4. A seamless integration for notifications in an Altinn App workflow.

Terminology

  • Notification order

    A notification order is the request to send one or multiple notifications to one or multiple recipients. A single order can result in the creation of one or multiple notifications.

    Here is an example of a standard notification order:

    {
      "id": "a56c0933-d609-4b5c-a5da-bccfd407c9b8",
      "creator": "ttd",
      "sendersReference": "test-2023-1",
      "requestedSendTime": "2024-01-02T13:49:31.5591909Z",
      "created": "2024-01-02T13:49:31.5799658Z",
      "notificationChannel": "Email",
      "recipients": [
        {
          "emailAddress": "testuser_1@altinn.no"
        },
          {
          "emailAddress": "testuser_2@altinn.no"
        }
      ],
      "emailTemplate": {
        "fromAddress": "noreply@altinn.cloud",
        "subject": "A test email from Altinn Notifications",
        "body": "A message sent from an application owner through Altinn.",
        "contentType": "Html"
      },
      "links": {
        "self": "https://platform.at22.altinn.cloud/notifications/api/v1/orders/a56c0933-d609-4b5c-a5da-bccfd407c9b8",
        "status": "https://platform.at22.altinn.cloud/notifications/api/v1/orders/a56c0933-d609-4b5c-a5da-bccfd407c9b8/status"
      }
    }
    
  • Notification

    A notification is the one instance of an email or SMS that is sent to a single recipient.

    Here is an example of a set of notifications related to an order:

    {
        "orderId": "a56c0933-d609-4b5c-a5da-bccfd407c9b8",
        "sendersReference": "test-2023-1",
        "generated": 2,
        "succeeded": 1,
        "notifications": [
            {
                "id": "a141753c-557f-4bce-95fd-8fc715ca9a40",
                "succeeded": true,
                "recipient": {
                    "emailAddress": "testuser_1@altinn.no"
                },
                "sendStatus": {
                    "status": "Succeeded",
                    "description": "The email has been accepted by the third party email service and will be sent shortly.",
                    "lastUpdate": "2024-01-02T13:51:12.706808Z"
                }
            }
               {
                "id": "a9d159e2-6a89-4440-80da-7f2a99c775f4",
                "succeeded": true,
                "recipient": {
                    "emailAddress": "testuser_2@altinn.no"
                },
                "sendStatus": {
                    "status": "Sending",
                    "description": "The email is being processed and will be attempted sent shortly." ,
                    "lastUpdate": "2024-01-02T13:51:12.706808Z"
                }
            }
        ]
    }
    
  • Notification channel

    A notification channel is the communication pathways through which Altinn enables you to communicate with your end users.

Notification channels

Currently, we support sending notifications through two channels:

  • email
  • sms

Future improvements

In the future, we plan to extend our notification channel options to provide even more flexibility and convenience. Our goal is to support a wider range of communication platforms. This expansion will allow both your organisation and the end users to communicate through the channels that best suit the end users preferences and communication habits.

Stay tuned for updates as we continue to enhance our notification capabilities to better serve your needs.

If you have any questions or feedback regarding notification channels, please don’t hesitate to reach out to us through GitHub.

Who can use Altinn Notifications

Altinn Notifications allows the following parties to send messages, provided they have obtained authorization through Maskinporten:

  • Registered service owners
  • Altinn Apps
  • Internal Altinn services

Guidelines for usage

Please reference our user guide on how and when to use Altinn Notifications