Event Object - Auth0 Docs

The event object for the custom-email-provider Actions trigger provides contextual information about the trigger execution.

Event Object

{
  "client": {
    "client_id": "string",
    "metadata": {},
    "name": "string"
  },
  "notification": {
    "from": "string",
    "html": "string",
    "locale": "string",
    "message_type": "string",
    "subject": "string",
    "text": "string",
    "to": "string"
  },
  "request": {},
  "tenant": {
    "id": "string"
  },
  "user": {},
  "secrets": {}
}

`event.client`

object

Information about the Client with which this login transaction was initiated.

Hide event.client properties

string

The client id of the application the user is logging in to.

dictionary

An object for holding other application properties.

string

The name of the application (as defined in the Dashboard).

`event.connection`

object

optional

Details about the Connection that was used to authenticate the user.

Hide event.connection properties

string

The connection’s unique identifier.

dictionary

optional

Metadata associated with the connection.

string

The name of the connection used to authenticate the user (such as twitter or some-g-suite-domain).

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.custom_domain`

object

optional

Details about the custom domain associated with the current transaction.

Hide event.custom_domain properties

string

The custom domain name.

dictionary

Custom domain metadata as key-value pairs.

`event.notification`

object

Hide event.notification properties

string

Email address of the sender for the email.

string

Rendered HTML template.

string

The locale we rendered the message in, example en_US, as defined in the BCP-47 specification.

string

The type of message that is being send, like verify_email or welcome_email.Allowed values: verify_email, verify_email_by_code, reset_email, reset_email_by_code, welcome_email, verification_code, mfa_oob_code, enrollment_email, blocked_account, stolen_credentials, try_provider_configuration_email, organization_invitation

string

Subject to be attached to the email.

string

Rendered text template.

string

Email address of the recipient.

`event.organization`

dictionary

optional

Details about the Organization associated with the current transaction.

Hide event.organization properties

string

The Organization identifier.

string

The friendly name of the Organization.

dictionary

Metadata associated with the Organization.

string

The name of the Organization.

`event.request`

object

Hide event.request properties

dictionary

optional

Hide geoip properties

string

optional

string

optional

string

optional

string

optional

string

optional

number

optional

number

optional

string

optional

string

optional

string

optional

string

optional

The hostname that is being used for the authentication flow.

string

optional

The originating IP address of the request.

dictionary

optional

The query string parameters sent to the authorization request.

string

optional

The value of the User-Agent header received when initiating the transaction.

`event.secrets`

secrets

Secret values securely associated with this Action.

`event.tenant`

object

Hide event.tenant properties

string

The name of the tenant.

string

optional

The friendly name for the tenant, usually a more human-readable version of the ID.

string

optional

The home URL for the tenant, if defined and as found in its settings.

string

optional

The logo URL for the tenant, if defined and as found in its settings.

string

optional

The email to the tenant’s support service, if defined and as found in its settings.

string

optional

The url to the tenant’s support service, if defined and as found in its settings.

`event.transaction`

object

optional

Details about the current transaction for tracing purposes.

Hide event.transaction properties

string

optional

A unique identifier to correlate this request across multiple services for distributed tracing.

`event.user`

dictionary

An object describing the user on whose behalf the current transaction was initiated.

Hide event.user properties

dictionary

Custom fields that store info about a user that influences the user’s access, such as support plan, security roles, or access control groups.

string

optional

(unique) User’s email address.

boolean

Indicates whether the user has verified their email address.

string

optional

User’s family name.

string

optional

User’s given name.

string

optional

User’s full name.

string

optional

User’s nickname.

string

optional

URL pointing to the user’s profile picture.

string

(unique) User’s unique identifier.

dictionary

Custom fields that store info about a user that does not impact what they can or cannot access, such as work address, home address, or user preferences.

string

optional

(unique) User’s username.

​event.client

​event.connection

​event.custom_domain

​event.notification

​event.organization

​event.request

​event.secrets

​event.tenant

​event.transaction

​event.user

`event.client`

`event.connection`

`event.custom_domain`

`event.notification`

`event.organization`

`event.request`

`event.secrets`

`event.tenant`

`event.transaction`

`event.user`