The event object for the custom-email-provider Actions trigger provides contextual information about the trigger execution.
event.clientInformation about the Client with which this login transaction was initiated. The client id of the application the user is logging in to.
An object for holding other application properties.
The name of the application (as defined in the Dashboard).
event.connectionDetails about the Connection that was used to authenticate the user. Hide connection properties
The connection’s unique identifier.
Metadata associated with the connection.
The name of the connection used to authenticate the user (such as twitter or some-g-suite-domain).
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_domainDetails about the custom domain associated with the current transaction. Hide custom_domain properties
Custom domain metadata as key-value pairs.
event.notificationHide notification properties
Email address of the sender for the email.
The locale we rendered the message in, example en_US, as defined in the BCP-47 specification.
The type of message that is being send, like verify_email or welcome_email. Possible values:
verify_emailverify_email_by_codereset_emailreset_email_by_codewelcome_emailverification_codemfa_oob_codeenrollment_emailblocked_accountstolen_credentialstry_provider_configuration_emailorganization_invitation Subject to be attached to the email.
Email address of the recipient.
event.organizationDetails about the Organization associated with the current transaction. Hide organization properties
The Organization identifier.
The friendly name of the Organization.
Metadata associated with the Organization.
The name of the Organization.
event.requestThe hostname that is being used for the authentication flow.
The originating IP address of the request.
The query string parameters sent to the authorization request.
The value of the User-Agent header received when initiating the transaction.
event.tenantThe friendly name for the tenant, usually a more human-readable version of the ID.
The home URL for the tenant, if defined and as found in its settings.
The logo URL for the tenant, if defined and as found in its settings.
The email to the tenant’s support service, if defined and as found in its settings.
The url to the tenant’s support service, if defined and as found in its settings.
event.transactionDetails about the current transaction for tracing purposes. Hide transaction properties
A unique identifier to correlate this request across multiple services for distributed tracing.
event.userAn object describing the user on whose behalf the current transaction was initiated. Custom fields that store info about a user that influences the user’s access, such as support plan, security roles, or access control groups.
(unique) User’s email address.
Indicates whether the user has verified their email address.
(unique) User’s unique identifier.
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.
(unique) User’s username.
event.secretsSecret values securely associated with this Action.
