Last modified: May 28, 2024


How to create custom email notifications for apps.

Activate generation of email notifications in your application

The email client is automatically added to the application. To use it, inject the IEmailNotificationClient-interface. The interface defines a method used to order an email notification from the Altinn Notifications API.

Code example

Below we see an example of trying to send an email notification when a user starts to fill out a form, by using the IProcessTaskStart interface.

using System;
using System.Collections.Generic;
using System.Threading;
using System.Threading.Tasks;
using Altinn.App.Core.Features;
using Altinn.App.Core.Internal.Notifications.Email;
using Altinn.App.Core.Models.Notifications.Email;
using Altinn.Platform.Storage.Interface.Models;
using Microsoft.Extensions.Logging;

namespace Altinn.App.Core;

public class EmailOnStart(ILogger<EmailOnStart> logger, IEmailNotificationClient emailNotificationClient)
    : IProcessTaskStart
    public async Task Start(string taskId, Instance instance, Dictionary<string, string> prefill)
        // "Task_1" is the name of the schema step in the bpmn process
        if (taskId != "Task_1")

            var order = new EmailNotification
                Subject = "Form started",
                Body = "You started filling out a form",
                SendersReference = "<my-schema-ref>",
                Recipients = [new("")],
            using var cts = new CancellationTokenSource(TimeSpan.FromSeconds(10));
            var orderResult = await emailNotificationClient.Order(order, cts.Token);
                "Task started, email sent to {EmailAddress} - OrderId={OrderId}",
        catch (EmailNotificationException e)
            logger.LogError(e, "Error sending email on task start");

Then we have to register the EmailOnStart class as IProcessTaskStart in Program.cs.

using Altinn.App.Core;
using Altinn.App.Core.Features;
using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;

void RegisterCustomAppServices(IServiceCollection services, IConfiguration config, IWebHostEnvironment env)
    services.AddSingleton<IProcessTaskStart, EmailOnStart>();