Actions Triggers: custom-phone-provider - Event Object

The event object for the custom-phone-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

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

as_text

string

The text, as we rendered it, ready to be delivered as a text message.

as_voice

string

The text, as we rendered it, ready to be delivered as a voicetext message.

code

string

optional

The One Time Password that we drawn for this message for some types (e.g. otp_verify, otp_enroll). If provided, it is important to have it conveyed to the end-user.

delivery_method

string

The way the message should be delivered. Could be text or voice.Allowed values: text, voice

from

string

optional

The E.164 compliant phone number for the sender.

locale

string

optional

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 otp_verify or blocked_account.Allowed values: otp_verify, otp_enroll, blocked_account, change_password, password_breach

recipient

string

The E.164 compliant phone number for the recipient.

`event.organization`

event.organization

dictionary

optional

Details about the Organization associated with the current transaction.

Hide organization properties

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

Details about the request that initiated the transaction.

Hide request properties

geoip

dictionary

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.

string

The originating IP address of the request.

language

string

optional

The language requested by the browser.

method

string

The HTTP method used for the request

user_agent

string

optional

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

`event.tenant`

event.tenant

object

Hide tenant properties

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.

created_at

string

Timestamp indicating when the user profile was first created.

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.

last_password_reset

string

optional

Timestamp indicating the last time the user’s password was reset/changed. At user creation, this field does not exist. This property is only available for Database connections.

name

string

optional

User’s full name.

nickname

string

optional

User’s nickname.

phone_number

string

optional

User’s phone number.

phone_verified

boolean

optional

Indicates whether the user has verified their phone number.

picture

string

optional

URL pointing to the user’s profile picture.

updated_at

string

Timestamp indicating when the user’s profile was last updated/modified.

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.

identities

array of objects

optional

Contains info retrieved from the identity provider with which the user originally authenticates. Users may also link their profile to multiple identity providers; those identities will then also appear in this array. The contents of an individual identity provider object varies by provider.

Hide identities properties

connection

string

optional

Name of the Auth0 connection used to authenticate the user.

Indicates whether the connection is a social one.

profileData

dictionary

optional

User information associated with the connection. When profiles are linked, it is populated with the associated user info for secondary accounts.

provider

string

optional

Name of the entity that is authenticating the user, such as Facebook, Google, SAML, or your own provider.

user_id

string

optional

User’s unique identifier for this connection/provider.

`event.secrets`

event.secrets

secrets

Secret values securely associated with this Action.

Brand Customization

Code Customization

Third-Party Customization

Actions Triggers: custom-phone-provider - Event Object

`event.client`

`event.connection`

`event.custom_domain`

`event.notification`

`event.organization`

`event.request`

`event.tenant`

`event.transaction`

`event.user`

`event.secrets`

Brand Customization

Code Customization

Third-Party Customization

​event.client

​event.connection

​event.custom_domain

​event.notification

​event.organization

​event.request

​event.tenant

​event.transaction

​event.user

​event.secrets

`event.client`

`event.connection`

`event.custom_domain`

`event.notification`

`event.organization`

`event.request`

`event.tenant`

`event.transaction`

`event.user`

`event.secrets`