PingOne

Using a custom email provider for notifications

To configure PingOne to use an external email service for sending notifications to your users:

  1. Go to Settings > Sender.

  2. On the Email tab, click the Pencil icon.

  3. In the Email Sender section, click Custom Provider.

    You can only have a single sender defined for a PingOne environment. After you select Custom Provider, any previous email sender settings are erased.

  4. For Provider Name, enter any name to identify the provider.

  5. For Authorization:

    • If your authentication with the email provider uses a username and password, select Basic and enter the username and password.

    • If your authentication is based on the use of a bearer token, select Bearer and enter the token to use.

  6. (Optional) Enter the From Name and From Address values you want to use in the notifications.

  7. (Optional) Enter the Reply-To Name and Reply-To Address values you want to use in the notifications.

  8. Provide the information required by your email provider’s API:

    1. In the Type list, select GET or POST to specify the type of API request that should be sent.

    2. In the URL field, enter the endpoint for your email provider, for example, https://api.example.com/email.

    3. If the type is set to POST, define the body of the request by selecting one of the options in the Body list: None, Form, or Raw.

      • If you select Form, use Key and Value to enter field names and values.

      • If you select Raw, use the Raw field to enter the information that will be used for the body of the request. The body that you define must include the PingOne variables listed in Required Variables: ${from}, ${to}, and ${message}.

      In both Raw and Form view, when you add one of the required variables to the body, it’s highlighted in green in the list. You can also include in the body of the notification the variables listed in Optional Variables.

    4. If the type is set to GET, append the query parameters that the email provider’s API requires to the URL. The URL must also include the required PingOne variables.

    5. Click Add Header to add whatever headers the email provider’s API requires.

    6. After entering all of the information, click Send Test Email to send an email to verify that everything is working correctly.

      When you edit existing settings for the email service, the password is not displayed when the page is loaded. To send a test email, you must re-enter the password. Because Password is a mandatory field, Save is disabled until you re-enter the password.

  9. Click Save.

    Save is disabled until you have filled in all the required fields and have included all the required variables in the body of the request.