Event Object

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

Event Object

{
  "client": {
    "client_id": "string",
    "metadata": {},
    "name": "string"
  },
  "notification": {
    "as_text": "string",
    "as_voice": "string",
    "delivery_method": "string",
    "message_type": "string",
    "recipient": "string"
  },
  "request": {
    "geoip": {},
    "ip": "string",
    "method": "string"
  },
  "tenant": {
    "id": "string"
  },
  "user": {},
  "secrets": {}
}

`event.client`

object

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

object

optional

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

Hide event.connection properties

string

The connection’s unique identifier.

dictionary

optional

Metadata associated with the connection.

string

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

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`

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.notification`

object

Hide event.notification properties

string

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

string

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

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.

string

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

string

optional

The E.164 compliant phone number for the sender.

string

optional

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

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

string

The E.164 compliant phone number for the recipient.

`event.organization`

dictionary

optional

Details about the Organization associated with the current transaction.

Hide event.organization properties

string

The Organization identifier.

string

The friendly name of the Organization.

dictionary

Metadata associated with the Organization.

string

The name of the Organization.

`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.tenant`

object

Hide event.tenant properties

string

The name of the tenant.

string

optional

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

string

optional

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

string

optional

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

string

optional

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

string

optional

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

`event.transaction`

object

optional

Details about the current transaction for tracing purposes.

Hide event.transaction properties

string

optional

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

`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.

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.

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.

Credentials Exchange

Custom Email Provider

Custom Phone Provider

Custom Token Exchange

Event Stream

Password Reset Post Challenge

Post Change Password

Post Login

Post User Registration

Pre User Registration

Send Phone Message

`event.client`

`event.connection`

`event.custom_domain`

`event.notification`

`event.organization`

`event.request`

`event.secrets`

`event.tenant`

`event.transaction`

`event.user`

​event.client

​event.connection

​event.custom_domain

​event.notification

​event.organization

​event.request

​event.secrets

​event.tenant

​event.transaction

​event.user

`event.client`

`event.connection`

`event.custom_domain`

`event.notification`

`event.organization`

`event.request`

`event.secrets`

`event.tenant`

`event.transaction`

`event.user`