API Public API The following API controllers are defined:
OrdersController: API for retrieving one or more orders with or without processing details and notification summaries EmailNotificationsOrdersController: API for placing new email notification order requests EmailNotificationsController: API for retrieving email notifications related to a single order SmsNotificationsOrdersController: API for placing new sms notification order requests SmsNotificationsController: API for retrieving sms notifications related to a single order Internal API The API controllers listed below are exclusively for use within in the Altinn organization: »
Integrations Kafka The Notifications email microservice has an integration towards a Kafka broker, and this integration is used both to publish and consume messages from topics relevant to the microservice.
Consumers:
The following Kafka consumers are defined:
SendEmailQueueConsumer: Consumes email objects with recipient data that are ready to be sent EmailSendingAcceptedConsumer: Consumes pairs of notification and communications services operation ids Producers:
A single producer KafkaProducer is implemented and used by all services that publish to Kafka. »
API Public API DeliveryReportController Endpoint receiving delivery reports in XML-format from SMS provider. The controller is protected with basic authentication. Integrations Kafka The Notifications sms microservice has an integration towards a Kafka broker, and this integration is used both to publish and consume messages from topics relevant to the microservice.
Consumers: The following Kafka consumers are defined:
SendSmsQueueConsumer: Consumes sms objects with recipient data that are ready to be sent Producers: A single producer KafkaProducer is implemented and used by all services that publish to Kafka. »
Sending notifications to a national identity number or organization number is supported. A lookup of the contact details and reservation status of the recipient will be done both at the time of ordering a request and at the requested send time.
The entity ordering the notification is responsible for checking whether the notification will be sent or not, as recipient lookup results are shared in the response of the order request as well as detailed in the notification after requested send time. »
Introduction The Send Condition feature allows you to register a notification order for a notification to be sent only if a specified condition is met. The requested send time can be either immediate or set for a future date.
Example Use Case A typical use case is setting reminders where a notification should be sent only if a user has not yet completed a certain action. By using the send condition, the notification requesting a user to complete an action and the reminder notification can be ordered simultaneously. »
Recipient lookup Send Condition »
Combining notification channels As of April ‘24 it is not possible to combine notification channels for a single order request. This functionality can be expected in the first half of ‘24. Recipient lookup Sending notifications to a national identity number or organization number is supported. A lookup of the contact details and reservation status of the recipient will be done both at the time of ordering a request and at the requested send time. »
