Email gateway configuration

The messaging service supports three ways of sending email messages out, by integrating with:

• The OneWelcome Identity Platform email gateway

• An SMTP server

• A custom API

Email gateway configuration

The OneWelcome Identity Platform email gateway is the default integration, because all necessary elements are hosted by the platform. To use this email gateway, you need to specify the sender email address, sender name, and reply-to address. Be aware that the OneWelcome Identity Platform only allows verified sender email addresses and domains.

SMTP server configuration

If you don't want to use the OneWelcome Identity Platform email gateway, you can configure any other SMTP server to send email.

In addition to the sender address, sender name, and reply-to address, you need to specify the hostname (or IP address) and port on which the SMTP server is accessible. You can also specify whether to mark the connection as secure and any required authentication details.

Custom API configuration

The custom API integration is meant to be used with any service that conforms to the OneWelcome Identity Platform API specification. See the API reference for details about the format and supported HTTP methods.

To configure the custom API integration, you must specify the URL of the endpoint to which the messaging service forwards the data. You can additionally specify the credentials if the endpoint is protected by basic authentication. You can also specify any other additional parameters that are passed to the custom endpoint along with the other notification related parameters, like content, sender, receiver, and so on.

The messaging service issues HTTP POST requests to the specified endpoint with all data required to send email notifications. The responsibility to actually send the message is moved to the custom API handler.