Skip to main content

Overview

This document outlines the steps necessary to deliver the platform's external notifications as e-mails through the Email Notification Provider.

Email Notification Provider​

The Email Notification Provider is the Connector that implements the Notification Provider interface for e-mail delivery:

Function GroupKind
Notification ProviderEMAIL

When an event triggers a notification profile that uses an instance of this connector, Core resolves the recipients and sends the notification request to the connector. The connector renders the subject and content of the e-mail from the templates of the instance, and sends it through its SMTP server to the addresses of the recipients.

Prerequisites​

Before you start, make sure that:

  • The Email Notification Provider is deployed with access to an SMTP server, and registered as a Connector in the platform. Deploying the connector is part of the installation: with the Helm chart, set emailNotificationProvider.enabled in the chart values; with the operator, deploy it with a Connector resource.
  • To include event data in the e-mails, the connector is version 1.3.0 or later.
  • The recipients can be reached by e-mail. Groups and roles need an e-mail address of their own, a user needs one or a custom attribute that holds one, and an Object recipient needs that custom attribute on the object. See mapping attributes.

Integration​

The following steps are required to deliver notifications by e-mail:

#ReferenceShort description
1Configure Notification InstanceCreate the notification instance with the sender address and the templates
2TemplatesWrite the subject and the content of the e-mails
3Send Notifications on EventsUse the instance in a notification profile, and send the profile from a trigger on the events to notify about