Actions Trigger Reference - Auth0 Docs

Triggers are points in the Auth0 process where Actions can be added for required customization. Multiple Actions can be placed in a trigger, executing in sequence. Excluding the Custom Token Exchange, triggers can be synchronous (blocking) or asynchronous (non-blocking). Every Auth0 Action receives two objects when its trigger fires:

The event object is read-only transaction context: details about the user, request, client, tenant, and connection at the moment the trigger fired.
The API object exposes the methods your Action can call to change the outcome of the transaction, such as denying access, adding token claims, triggering challenges, or caching data.

The objects differ per trigger and may differ based on your connection (such as connection).

View a summarized list of avaiable triggers.

Signup and Login: When a user is added to a database or passwordless connection (Signup), or as part of a user’s authentication transaction (Login).

Trigger	Description
`pre-user-registration`	Triggers before a user is created.
`post-user-registration`	Triggers asynchronously after a user is created.
`post-login`	Triggers after a user is authenticated but before a token is issued.

MFA Notifications: When using SMS as a factor for (MFA) or to configure a custom provider.
Trigger Description
send-phone-message Triggers when using a custom provider to send the messages for the enrollment and the challenge process.
Password Reset: When a password reset request is initiated.
Trigger Description
post-change-password Triggers after a password is changed.
password-reset-post-challenge Triggers after the first challenge is completed and before the password is reset.
Machine to Machine: When an application, instead of a user, is authenticated and authorized to use your APIs.
Trigger Description
credentials-exchange Triggers before an access token is returned.
Custom Token Exchange: When a Custom Token Exchange Request is received to log a user in.
Trigger Description
custom-token-exchange Triggers at first step for the transaction, before the post-login trigger.

Credentials Exchange

About the Credentials Exchange Trigger

Credentials Exchange Actions run when an Access Token is issued as part of the Machine to Machine Flow. They can be used to deny the exchange or add custom claims to the access token.

Event Object

Learn about the credentials-exchange Action trigger's event object, which provides contextual information about the trigger execution.

API Object

Learn about the credentials-exchange Action trigger's API object.

Custom Token Exchange

About the Custom Token Exchange Trigger

Custom Token Exchange Actions run when the Auth0 Authorization Server receives a Custom Token Exchange request to log a user in.

Event Object

Learn about the custom-token-exchange Action trigger's event object, which provides contextual information about the trigger execution.

API Object

Learn about the custom-token-exchange Action trigger's API object.

Event Stream

About the Event Stream Trigger

Event Stream Actions run asynchronously when subscribed event types occur within your Auth0 tenant. They can be used to forward events to external systems without affecting the user's transaction.

Event Object

Learn about the event-stream Action trigger's event object, which provides contextual information about the trigger execution.

API Object

Learn about the event-stream Action trigger's API object.

Password Reset Post Challenge

About the Password Reset Post Challenge Trigger

Password Reset Post Challenge Actions run after a user completes the first challenge during the password reset journey but before they set a new password.

Event Object

Learn about the password-reset-post-challenge Action trigger's event object, which provides contextual information about the trigger execution.

API Object

Learn about the password-reset-post-challenge Action trigger's API object.

Post Change Password

About the Post Change Password Trigger

Post Change Password Actions run after a Database connection user resets or changes their password. They can be used to notify another system that the user's password has changed.

Event Object

Learn about the post-change-password Action trigger's event object, which provides contextual information about the trigger execution.

API Object

Learn about the post-change-password Action trigger's API object.

Post Login

About the Post Login Trigger

Post Login Actions run after a user logs in and when a Refresh Token is requested. They can be used to control access, enrich tokens and user profiles, and enforce custom MFA policies.

Event Object

Learn about the post-login Action trigger's event object, which provides contextual information about the trigger execution.

API Object

Learn about the post-login Action trigger's API object.

Post User Registration

About the Post User Registration Trigger

Post User Registration Actions run after a user has been created for a Database or Passwordless connection. They can be used to notify another system that a user has registered.

Event Object

Learn about the post-user-registration Action trigger's event object, which provides contextual information about the trigger execution.

API Object

Learn about the post-user-registration Action trigger's API object.

Pre User Registration

About the Pre User Registration Trigger

Pre User Registration Actions run before a user is added to a Database or Passwordless connection. They can be used to add metadata to the user profile before it is created or to deny a registration.

Event Object

Learn about the pre-user-registration Action trigger's event object, which provides contextual information about the trigger execution.

API Object

Learn about the pre-user-registration Action trigger's API object.

Send Phone Message

About the Send Phone Message Trigger

Send Phone Message Actions run during the enrollment and challenge process when SMS or Voice is used as a factor for Multi-factor Authentication (MFA).

Event Object

Learn about the send-phone-message Action trigger's event object, which provides contextual information about the trigger execution.

API Object

Learn about the send-phone-message Action trigger's API object.