Configure a Custom Email Provider

You can set up any email provider using the Custom Email Provider option. It leverages our Actions Code Editor to give you full control of the email delivery process.

Configure Custom Email Provider

  1. Go to Auth0 Dashboard > Branding > Email Provider.

  2. Enable the Use my own email provider toggle.

  3. In the Email Provider Section, select Custom Provider.

  4. Under Provider Configuration, add the appropriate Actions code to deliver messages to your custom email provider:

    1. Consult with your provider's documentation to understand how to deliver messages to their API.

    2. Add any required secrets to authenticate with the API.

    3. Like other Actions, use the Management API to manage the Action and its versions.

5. Click Edit in Expanded Editor. In the Expanded Editor, you can add secrets, dependencies, and test your Action. To learn more about writing and deploying Actions, read Write Your First Action. You can also access the Version History of previously deployed Actions.

6. To deploy your action, click Deploy in the top right corner of the Expanded Editor.

7. Click Back to Email Provider in the top left corner of the Expanded Editor. You should see a green check and Enabled in the Provider Configuration section.

8. Click Save to finalize your custom email provider configuration. When you click Save, your Action is automatically saved and deployed.

9. To test your custom email provider configuration before using it in a production environment, click Send Test Email. You cannot send a test email until after you save your custom email provider configuration.

Use Cases

While the primary use case is to deliver messages to providers that are not supported by the default email options, other use cases include:

  • Retrying failures

  • Changing recipient(s)

  • Changing message payload

  • Creating Organization-specific logic

Remove the Action

The Custom Email Provider option on Auth0 Dashboard > Branding > Email Provider must be disabled before the Action can be deleted in order to prevent accidental email delivery failures.