Notifications in Altinn 3 Correspondence

How to get started with Notifications in Altinn 3 Correspondence, for developers

To use notifications in Altinn Correspondence, a notification order is placed when a message is created. The notification will be sent out 5 minutes after the publication time of the message. If the publication time is in the past, the notification will be sent 5 minutes after the current time. If a reminder is activated, the reminder will be sent after 7 days if the message has not been read. In the test and staging environment, the reminder will be sent out after 1 day if the message has not been read.

Notifications can be sent via either email or SMS. While email does not have a time window, SMS notifications are sent between 9:00 AM and 5:00 PM. If the sending time falls outside this window, the notification will be sent the following day.

A notification order is made by adding the following when initializing a message:

{
  "correspondence": {
    ...,
    "notification": {
      "notificationTemplate": CustomMessage (0) | GenericAltinnMessage(1),
      "notificationChannel": Email(0) | Sms(1) | EmailPreferred(2) | SmsPreferred(3) | EmailAndSms(4),
      "sendReminder": boolean,
      "emailBody": string?,
      "emailSubject": string?,
      "smsBody": string?,
      "reminderNotificationChannel": Email(0) | Sms(1) | EmailPreferred(2) | SmsPreferred(3) | EmailAndSms(4),
      "reminderEmailBody": string?,
      "reminderEmailSubject": string?,
      "reminderSmsBody": string?,
      "requestedSendTime": DateTimeOffset?,
      "customRecipient": {
        "organizationNumber": string?,
        "nationalIdentityNumber": string?,
        "mobileNumber": string?,
        "emailAddress": string?
      }
    }
  },
  "Recipients": [],
  "ExistingAttachments":{...}
}

Keyword support

Keywords is a list of tokens which enable personalization in notifications. These will be automaticly supplied with text by Altinn.

Notification Templates

Two types of notification templates are offered when using notifications through the Correspondence API.

CustomText:

• The entire message is written by the sender and sent in full to the recipient.

GenericAltinnMessage:

A generic Altinn text with the option to supplement with additional text. Currently supported languages are Norwegian, Nynorsk, and English. The language is chosen based on the language defined in the message.

Title: A message has been received in Altinn {textToken}
Content: Hello. $correspondenceRecipientName$ has received a new message from $sendersName$. {textToken} Log in to Altinn to see this message.

Reminder Title: Reminder - a message has been received in Altinn {textToken}
Reminder Content: Hello. This is a reminder that $correspondenceRecipientName$ has received a new message from $sendersName$. {textToken} Log in to Altinn to see this message.

In the text, textToken will be replaced with the value given in, for example, “EmailSubject” for the title. SMS uses only the content, not the title.

Note! Links should NEVER be used in notifications.

Notification Channels

Supported notification channels:

• Email: Sends an email to the recipient.
• SMS: Sends an SMS to the recipient. Supports both national and international phone numbers.
• EmailPreferred: Uses email as the main communication channel, and SMS as a fallback if email is not available.
• SmsPreferred: Uses SMS as the main communication channel, and email as a fallback if SMS is not available.
• EmailAndSms: Sends both email and SMS to the recipient simultaneously. The first notification and the reminder notification can use different notification channels. For example, the first notification is sent by email, while the reminder notification seven days later is sent by SMS.

Cancellation of Notification

If a message is deleted before the publication date, the notification order will also be deleted. In situations where an error occurs during the publication of a message, the notification will also be deleted.

Errors in Notification Ordering

If no contact information is available for a recipient, the message will still be sent as planned. Information about the notification can be viewed by retrieving the details about the specific correspondence. Improvements are planned to provide feedback on this during the creation of a message.

Custom recipients for Notifications

For all correspondences created with Notifications enabled, the notifications will be sent to the recipient specified in the creation of the correspondence. However, it is also possible to choose optional recipients of the notification that are not necessarily the recipient(s) of the correspondence. In practice this means that custom recipients will override/replace the original recipient provided for the notification.

Using customNotificationRecipients (Deprecated)

This can be achieved by populating the customNotificationRecipients field under notification as follows:

{
  "notification": {
    ...,
    "customNotificationRecipients": [
      {
        "recipientToOverride": "string",
        "notificationRecipient": [
          {
            "organizationNumber": "string",
            "nationalIdentityNumber": "string",
            "mobileNumber": "string",
            "emailAddress": "string"
          }
        ]
      }
    ]
  }
}

Using customRecipient (Recommended)

The recommended approach is to use the customRecipient field under notification as follows:

{
  "notification": {
    ...,
    "customRecipient": {
      "organizationNumber": "string",
      "nationalIdentityNumber": "string",
      "mobileNumber": "string",
      "emailAddress": "string"
    }
  }
}

How to use it

For deprecated approach:

correspondence.notification.customNotificationRecipients[0].recipientToOverride
correspondence.notification.customNotificationRecipients[0].recipients[0].organizationNumber
correspondence.notification.customNotificationRecipients[0].recipients[0].nationalIdentityNumber
correspondence.notification.customNotificationRecipients[0].recipients[0].mobileNumber
correspondence.notification.customNotificationRecipients[0].recipients[0].emailAddress

For recommended approach:

correspondence.notification.customRecipient.organizationNumber
correspondence.notification.customRecipient.nationalIdentityNumber
correspondence.notification.customRecipient.mobileNumber
correspondence.notification.customRecipient.emailAddress

Explanation of template and channel

For each of the optional recipients (in both approaches), it is only possible to provide one of the following fields:

1. Organization number
2. National identity number
3. Mobile number and/or email address

If either mobile number or email address is used, they must follow the correct format in order to be able to send the notifications. For emails, most of the values are accepted as long as they are on the form ‘user@example.com’. For mobile numbers, they must satisfy the E.164 format.