Event Object

Learn about the custom-email-provider Action trigger’s event object, which provides contextual information about the trigger execution.

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

event.client

event.client · dictionary

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

Hide client 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

event.connection · dictionary · optional

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

Hide connection properties

id · string

The connection’s unique identifier.

metadata · dictionary · optional

Metadata associated with the connection.

name · string

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

strategy · 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

event.custom_domain · dictionary · optional

Details about the custom domain associated with the current transaction.

Hide custom_domain properties

domain · string

The custom domain name.

domain_metadata · dictionary

Custom domain metadata as key-value pairs.

event.notification

event.notification · object

Hide notification properties

from · string

Email address of the sender for the email.

html · string

Rendered HTML template.

locale · string

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

message_type · string

The type of message that is being send, like verify_email or welcome_email.

Possible 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

subject · string

Subject to be attached to the email.

text · string

Rendered text template.

to · string

Email address of the recipient.

event.organization

event.organization · dictionary · optional

Details about the Organization associated with the current transaction.

Hide organization properties

id · string

The Organization identifier.

display_name · string

The friendly name of the Organization.

metadata · dictionary

Metadata associated with the Organization.

name · string

The name of the Organization.

event.request

event.request · dictionary

Hide request properties

geoip · dictionary · optional

Hide geoip properties

cityName · string · optional

continentCode · string · optional

countryCode · string · optional

countryCode3 · string · optional

countryName · string · optional

latitude · number · optional

longitude · number · optional

subdivisionCode · string · optional

subdivisionName · string · optional

timeZone · string · optional

hostname · string · optional

The hostname that is being used for the authentication flow.

ip · string · optional

The originating IP address of the request.

query · dictionary · optional

The query string parameters sent to the authorization request.

user_agent · string · optional

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

event.secrets

event.secrets · secrets

Secret values securely associated with this Action.

event.tenant

event.tenant · object

Hide tenant properties

id · string

The name of the tenant.

friendly_name · string · optional

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

home_url · string · optional

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

logo_url · string · optional

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

support_email · string · optional

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

support_url · string · optional

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

event.transaction

event.transaction · object · optional

Details about the current transaction for tracing purposes.

Hide transaction properties

correlation_id · string · optional

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

event.user

event.user · dictionary

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

Hide user properties

app_metadata · 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.

email · string · optional

(unique) User’s email address.

email_verified · boolean

Indicates whether the user has verified their email address.

family_name · string · optional

User’s family name.

given_name · string · optional

User’s given name.

name · string · optional

User’s full name.

nickname · string · optional

User’s nickname.

picture · string · optional

URL pointing to the user’s profile picture.

user_id · string

(unique) User’s unique identifier.

user_metadata · 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.

username · string · optional

(unique) User’s username.