Actions Triggers: send-phone-message - Event Object

Learn about the send-phone-message Action trigger’s event object, which provides contextual information about the trigger execution.

The event object for the send-phone-message Actions trigger provides contextual information about the trigger execution.

event.client

event.client · dictionary · optional

Information about the Client with which this 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.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.message_options

event.message_options · object

Details about the message that is sent to the user.

Hide message_options properties

action · string

The flow that triggered this action.

Allowed values: enrollment, second-factor-authentication

code · string

One-time password that the user needs to use to enter in the form.

message_type · string

How the message will be delivered, either by ‘sms’ or ‘voice’.

Allowed values: sms, voice

recipient · string

Phone number where the message will be sent.

text · string

Content of the message to be sent.

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.

ip · 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.secrets

event.secrets · secrets

Secret values securely associated with this Action.

event.security_context

event.security_context · object · optional

An object containing fingerprint signatures. This will be available only if the client is using cloudflare. The JA3/JA4 fingerprint can be null or empty in some cases. The most common case is for HTTP requests because JA3 and JA4 are calculated in TLS. It can also be empty due to the Worker sending requests within the same zone or to a zone that is not proxied (or a third party).

Hide security_context properties

ja3 · string · optional

JA3 fingerprint signature. This will be available only if the client is using a TLS connection.

ja4 · string · optional

JA4 fingerprint signature. This will be available only if the client is using a TLS connection.

event.tenant

event.tenant · object

Details about the Tenant associated with the current transaction.

Hide tenant properties

id · string

The name of the tenant.

event.transaction

event.transaction · object · optional

Details about the current transaction.

Hide transaction properties

correlation_id · string · optional

Correlation ID can be provided in the initial authentication request when the application redirects to Universal Login. You can use value to correlate logs and requests from your Action code with the user flow.

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.

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.

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.

isSocial · boolean · optional

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.