Action Triggers: custom-email-provider Event Object
Custom email providers are currently in Early Access. To learn more about Auth0 releases, review Product Release Stages.
The
event
object for the
custom-email-provider
Actions trigger provides contextual information about email data.
Property |
Description |
event.client
|
Information about the Client with which this login transaction was
initiated.
Includes the following properties:
-
client_id String.
The client ID of the application the user is logging in to.
-
metadata Dictionary.
An object for holding other application properties.
-
name String.
The name of the application (as defined in the Dashboard).
|
event.connection
(Optional)
|
Details about the Connection that was used to authenticate the user.
Includes the following properties:
-
id Optional string.
The connection's unique identifier.
-
metadata Optional dictionary.
Metadata associated with the connection.
-
name Optional string.
The name of the connection used to authenticate the user (such as
twitter or some-g-suite-domain ).
-
strategy Optional string.
The type of connection. For social connections,
event.connection.strategy === event.connection.name .
For enterprise connections, the strategy is
waad (Windows Azure AD), ad (Active
Directory/LDAP), auth0 (database connections), and so
on.
|
event.notification
|
Includes the following properties:
|
event.organization
(Optional)
|
Details about the Organization associated with the current
transaction.
Includes the following properties:
-
display_name String.
The friendly name of the Organization.
-
id String.
The Organization identifier.
-
metadata Dictionary.
Metadata associated with the Organization.
-
name String.
The name of the Organization.
|
event.request
(Optional)
|
Includes the following properties:
|
event.tenant
|
Includes the following properties:
-
friendly_name Optional string.
The friendly name for the tenant, usually a more human-readable
version of the ID.
-
home_url Optional string.
The home URL for the tenant, if defined and as found in its
settings.
-
id String.
The name of the tenant.
-
logo_url Optional string.
The logo URL for the tenant, if defined and as found in its
settings.
-
support_email Optional string.
The email to the tenant's support service, if defined and as
found in its settings.
-
support_url Optional string.
The url to the tenant's support service, if defined and as found
in its settings.
|
event.user
|
An object describing the user on whose behalf the current transaction
was initiated.
Includes the following properties:
-
app_metadata Dictionary.
Custom fields that store information about a user that influences the
user's access, such as support plan, security roles, or access
control groups.
-
email Optional string.
(unique) User's email address.
-
email_verified Boolean.
Indicates whether the user has verified their email
address.
-
family_name Optional string.
User's family name.
-
given_name Optional string.
User's given name.
-
name Optional string.
User's full name.
-
nickname Optional string.
User's nickname.
-
picture Optional string.
URL pointing to the
user's profile picture.
-
user_id String.
(unique) User's unique identifier.
-
user_metadata Dictionary.
Custom fields that store information about a user that does not impact
what they can or cannot access, such as work address, home
address, or user preferences.
-
username Optional string.
(unique) User's username.
|