Auth0

NotificationAPI is an all-in-one notification service for B2B SaaS teams. This page covers two official Auth0 integrations.

Email Verification

This integration routes your Auth0 Verification Emails through NotificationAPI. This allows you to centrally customize, send, and monitor your application notifications at scale.

Find it on the Auth0 Marketplace: @https://marketplace.auth0.com/integrations/notificationapi-email-verification

Prerequisites

Set up NotificationAPI

To configure the integration with NotificationAPI:

  1. Log in to your NotificationAPI account.
  2. Navigate to the API section.
  3. Note down the Client ID and Client Secret for the API client.
  4. Create a new notification and note down the Notification ID.
  5. Edit the email template to include the verificationLink and/or otp as parameters. You can customize the email content to match your branding and messaging requirements.

Add the Auth0 Action

Note: Once the Action is successfully deployed, all logins for your tenant will be processed by this integration. Before activating the integration in production, install and verify this Action on a test tenant.

  1. Select Add Integration (at the top of this page).

  2. Read the necessary access requirements, and select Continue.

  3. Configure the integration using the following fields:

    • NOTIFICATION_API_CLIENT_ID: The Client ID for the NotificationAPI.
    • NOTIFICATION_API_CLIENT_SECRET: The Client Secret for the NotificationAPI.
    • MANAGEMENT_API_CLIENT_ID: The Client ID for the Auth0 Management API.
    • MANAGEMENT_API_CLIENT_SECRET: The Client Secret for the Auth0 Management API.
    • AUTH0_DOMAIN: Your Auth0 domain (e.g., your-tenant.auth0.com).
    • RESULT_URL: The URL to redirect users after email verification.
    • NOTIFICATION_ID: The Notification ID for the NotificationAPI template.
    • OTP_EXPIRATION_TIME: (Optional) The expiration time for the OTP in minutes. Default is 10 minutes.
    • LINK_EXPIRATION_HOURS: (Optional) The expiration time for the email verification link in hours. Default is 120 hours (5 days).

  4. Add the integration to your Library by selecting Create.

  5. In the modal that appears, select the Add to flow link.

  6. Drag the Action into the desired location in the flow.

  7. Select Apply Changes.

Results

When the Action is configured and deployed, new user registrations will trigger the following actions:

  • Generate a 6-digit OTP and store it in the user’s app_metadata.
  • Generate an email verification link with the specified expiration time.
  • Send a verification email via NotificationAPI containing the verification link and/or OTP.

Troubleshooting

  • Ensure all required secrets are provided and correctly configured.
  • Check the Auth0 logs for any errors related to the Action.
  • Verify that the NotificationAPI credentials and Notification ID are correct.
  • If the OTP or email verification link is not working, check the expiration times and ensure they are correctly set.
  • For further assistance, refer to the Auth0 documentation or NotificationAPI support.

SMS & Voice OTP Verification

This integration routes your Auth0 SMS and Voice verification codes (OTP) through NotificationAPI. This allows you to centrally customize, send, and monitor your application notifications at scale.

Find it on the Auth0 Marketplace: @https://marketplace.auth0.com/integrations/notificationapi-sms

Prerequisites

Set up NotificationAPI

To configure the integration with NotificationAPI:

  1. Log in to your NotificationAPI account.
  2. Navigate to the API section.
  3. Note down the Client ID and Client Secret for the API client.
  4. Create a new notification and note down the Notification ID.
  5. Edit the SMS template to include the otp as a parameter. You can customize the SMS content to match your messaging requirements.

Add the Auth0 Action

Note: Once the Action is successfully deployed, all logins for your tenant will be processed by this integration. Before activating the integration in production, install and verify this Action on a test tenant.

  1. Select Add Integration (at the top of this page).

  2. Read the necessary access requirements, and select Continue.

  3. Configure the integration using the following fields:

    • NOTIFICATION_API_BASE_URL: The base URL for the Notification API - the default is for the US region.
    • NOTIFICATION_ID: The Notification ID for the NotificationAPI template.
    • NOTIFICATION_API_CLIENT_ID: The Client ID for the NotificationAPI.
    • NOTIFICATION_API_CLIENT_SECRET: The Client Secret for the NotificationAPI.

  4. Add the integration to your Library by selecting Create.

  5. Open the Triggers section and select Send Phone Message trigger.

  6. Drag NotificationAPI into the workflow.

  7. Select Apply Changes.

Activate custom SMS factor

To use the SMS factor, your tenant needs to have MFA enabled globally or required for specific contexts using rules. To learn how to enable the MFA feature, see:

Finally, configure the SMS factor to use the custom code and test the MFA flow.

Note: Once you complete the steps below, Auth0 will begin using this factor for MFA during login. Before activating the integration in production, make sure you have configured all components correctly, and install and verify this Action on a test tenant.

  1. Go to Dashboard > Security > Multi-factor Auth, and select Phone Message.
  2. In the modal that appears, select Custom for the delivery provider and save.
  3. Make sure the SMS factor toggle is on.

Troubleshoot

If you do not receive the text message, look in the tenant logs for a failed SMS log entry. To learn which event types to search, see the Log Event Type Code list, or you can use the Filter control to find MFA errors.

Make sure that:

  • The Action is in the Send Phone Message flow.
  • The secrets match the ones you created in the steps above.
  • Your NotificationAPI account is active (not suspended).
  • Your phone number is formatted using the E.164 format.
  • For further assistance, refer to the Auth0 documentation or NotificationAPI support.

Feedback and support

If you have any questions or need help, feel free to reach out to us at support@notificationapi.com.