Event Object

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

Event Object

{
  "secrets": {},
  "message_options": {
    "action": "string",
    "code": "string",
    "message_type": "string",
    "recipient": "string",
    "text": "string"
  },
  "request": {
    "geoip": {},
    "ip": "string",
    "method": "string"
  },
  "tenant": {
    "id": "string"
  },
  "user": {}
}

`event.client`

object

optional

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

object

Details about the message that is sent to the user.

Hide event.message_options properties

string

The flow that triggered this action.Allowed values: enrollment, second-factor-authentication

string

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

string

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

string

Phone number where the message will be sent.

string

Content of the message to be sent.

`event.request`

object

Details about the request that initiated the transaction.

Hide event.request properties

dictionary

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

The originating IP address of the request.

string

optional

The language requested by the browser.

string

The HTTP method used for the 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.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 event.security_context properties

string

optional

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

string

optional

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

`event.tenant`

object

Details about the Tenant associated with the current transaction.

Hide event.tenant properties

string

The name of the tenant.

`event.transaction`

object

optional

Details about the current transaction.

Hide event.transaction properties

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`

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

Timestamp indicating when the user profile was first created.

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

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.

string

optional

User’s full name.

string

optional

User’s nickname.

string

optional

User’s phone number.

boolean

optional

Indicates whether the user has verified their phone number.

string

optional

URL pointing to the user’s profile picture.

string

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

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.

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.

Concepts

How To

Reference

Use Cases

`event.client`

`event.custom_domain`

`event.message_options`

`event.request`

`event.secrets`

`event.security_context`

`event.tenant`

`event.transaction`

`event.user`

​event.client

​event.custom_domain

​event.message_options

​event.request

​event.secrets

​event.security_context

​event.tenant

​event.transaction

​event.user

`event.client`

`event.custom_domain`

`event.message_options`

`event.request`

`event.secrets`

`event.security_context`

`event.tenant`

`event.transaction`

`event.user`