> ## Documentation Index
> Fetch the complete documentation index at: https://auth0-cq3uo.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Actions Triggers: custom-phone-provider Event Object

Phone messaging providers are currently in Early Access. To learn more about Auth0 releases, review [Product Release Stages](https://auth0-cq3uo.mintlify.site/docs/troubleshoot/product-lifecycle/product-release-stages.md).

The `event` object for the `custom-phone-provider` Actions trigger provides contextual information about the request for sending and receiving a custom phone message.

<table>
  <thead>
    <tr>
      <th>Property</th>
      <th>Description</th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        `event.client`
      </td>

      <td>
        Information about the Client with which this login transaction was
        initiated.

        Includes the following properties:

        <ul>
          <li>
            `client_id` *String*.
            The client ID (Identification value given to your registered resource from Auth0.) of the application the user is logging in to.
          </li>

          <li>
            `metadata` *Dictionary*.
            An object for holding other application properties.
          </li>

          <li>
            `name` *String*.
            The name of the application (as defined in the Dashboard).
          </li>
        </ul>
      </td>
    </tr>

    <tr>
      <td>
        `event.connection`*(Optional)*
      </td>

      <td>
        Details about the Connection that was used to authenticate the user.

        Includes the following properties:

        <ul>
          <li>
            `id` *Optional string*.
            The connection's unique identifier.
          </li>

          <li>
            `metadata` *Optional dictionary*.
            Metadata associated with the connection.
          </li>

          <li>
            `name` *Optional string*.
            The name of the connection used to authenticate the user (such as
            `twitter` or `some-g-suite-domain`).
          </li>

          <li>
            `strategy` *Optional 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.
          </li>
        </ul>
      </td>
    </tr>

    <tr>
      <td>
        `event.notification`
      </td>

      <td>
        Includes the following properties:

        <ul>
          <li>
            `from` *String*.
            The E.164 compliant phone number for the sender.
          </li>

          <li>
            `locale` *String*.
            The locale we rendered the message in, for example
            `en_US`, as defined in the BCP-47 specification.
          </li>

          <li>
            `message_type` *String*.

            The type of message that is being sent, like
            `otp_verify` or `blocked_account`.

            Possible values include:

            <ul>
              <li>`otp_verify`</li>
              <li>`otp_enroll`</li>
              <li>`blocked_account`</li>
              <li>`change_password`</li>
              <li>`password_breach`</li>
            </ul>
          </li>

          <li>
            `recipient` *String*.
            The E.164 compliant phone number for the recipient.
          </li>

          <li>
            `delivery_method` *Enum*.
            The way the message should be delivered. Could be `text` or `voice`.
          </li>

          <li>
            `code` *String*.
            The One-Time Password for some `message_types` (e.g. `otp_verify`, `otp_enroll`).
          </li>

          <li>
            `as_text` *String*.
            The rendered text ready to be delivered as a text message.
          </li>

          <li>
            `as_voice` *String*.
            The rendered text ready to be delivered as a voice text message.
          </li>
        </ul>
      </td>
    </tr>

    <tr>
      <td>
        `event.organization`*(Optional)*
      </td>

      <td>
        Details about the Organization associated with the current
        transaction.

        Includes the following properties:

        <ul>
          <li>
            `display_name` *String*.
            The friendly name of the Organization.
          </li>

          <li>
            `id` *String*.
            The Organization identifier.
          </li>

          <li>
            `metadata` *Dictionary*.
            Metadata associated with the Organization.
          </li>

          <li>
            `name` *String*.
            The name of the Organization.
          </li>
        </ul>
      </td>
    </tr>

    <tr>
      <td>
        `event.request`*(Optional)*
      </td>

      <td>
        Details about the request that initiated the transaction.Includes the following properties:

        <ul>
          <li>
            `geoip` *Optional object*.
            Includes the following properties:

            <ul>
              <li>`countryCode` *Optional string*.</li>
              <li>`countryCode3` *Optional string*.</li>
              <li>`cityName` *Optional string*.</li>
              <li>`latitude` *Optional string*.</li>
              <li>`longitude` *Optional string*.</li>
              <li>`timeZone` *Optional string*.</li>
              <li>`subdivisionCode` *Optional string*.</li>
              <li>`subdivisionName` *Optional string*.</li>
              <li>`continentCode` *Optional string*.</li>
              <li>`continentCode` *Optional string*.</li>
            </ul>
          </li>

          <li>
            `ip` *Optional string*.
            The originating IP address of the request.
          </li>

          <li>
            `hostname` *Optional string*.
            The hostname that is being used for the authentication flow.
          </li>

          <li>
            `method` *Optional string*.
            The HTTP method used for the request.
          </li>

          <li>
            `language` *Optional string*.
            The language requested by the browser.
          </li>

          <li>
            `user_agent` *Optional string*.
            The value of the `User-Agent` header received when
            initiating the transaction.
          </li>
        </ul>
      </td>
    </tr>

    <tr>
      <td>
        `event.tenant`
      </td>

      <td>
        Includes the following properties:

        <ul>
          <li>
            `friendly_name` *Optional string*.
            The friendly name for the tenant, usually a more human-readable
            version of the ID.
          </li>

          <li>
            `home_url` *Optional string*.
            The home URL for the tenant, if defined and as found in its
            settings.
          </li>

          <li>
            `id` *String*.
            The name of the tenant.
          </li>

          <li>
            `logo_url` *Optional string*.
            The logo URL for the tenant, if defined and as found in its
            settings.
          </li>

          <li>
            `support_email` *Optional string*.
            The email to the tenant's support service, if defined and as
            found in its settings.
          </li>

          <li>
            `support_url` *Optional string*.
            The url to the tenant's support service, if defined and as found
            in its settings.
          </li>
        </ul>
      </td>
    </tr>

    <tr>
      <td>
        `event.user`
      </td>

      <td>
        An object describing the user on whose behalf the current transaction
        was initiated.

        Includes the following properties:

        <ul>
          <li>
            `app_metadata` *Dictionary*.
            Custom fields that store information about a user that influences the
            user's access, such as support plan, security roles, or access
            control groups.
          </li>

          <li>
            `email` *Optional string*.
            (unique) User's email address.
          </li>

          <li>
            `email_verified` *Boolean*.
            Indicates whether the user has verified their email
            address.
          </li>

          <li>
            `family_name` *Optional string*.
            User's family name.
          </li>

          <li>
            `given_name` *Optional string*.
            User's given name.
          </li>

          <li>
            `name` *Optional string*.
            User's full name.
          </li>

          <li>
            `nickname` *Optional string*.
            User's nickname.
          </li>

          <li>
            `picture` *Optional string*.
            URL pointing to the
            [user's profile picture](https://auth0-cq3uo.mintlify.site/docs/manage-users/user-accounts/change-user-picture.md).
          </li>

          <li>
            `user_id` *String*.
            (unique) User's unique identifier.
          </li>

          <li>
            `user_metadata` *Dictionary*.
            Custom fields that store information about a user that does not impact
            what they can or cannot access, such as work address, home
            address, or user preferences.
          </li>

          <li>
            `username` *Optional string*.
            (unique) User's username.
          </li>
        </ul>
      </td>
    </tr>
  </tbody>
</table>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.