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

> Learn how to use to custom-phone-provider Event Object to configure a custom phone provider.

# Actions Triggers: custom-phone-provider Event Object

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 class="table">
  <thead>
    <tr>
      <th>Property</th>
      <th>Description</th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        <p><code>event.client</code></p>
      </td>

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

        <p>Includes the following properties:</p>

        <ul>
          <li>
            <code>client\_id</code> <em>String</em>.
            <span>The <Tooltip tip="Identification value given to your registered resource from Auth0." cta="View Glossary" href="/docs/glossary?term=client+ID">client ID</Tooltip> of the application the user is logging in to.</span>
          </li>

          <li>
            <code>metadata</code> <em>Dictionary</em>.
            <span>An object for holding other application properties.</span>
          </li>

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

    <tr>
      <td>
        <p><code>event.connection</code></p>
        <p><em>(Optional)</em></p>
      </td>

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

        <p>Includes the following properties:</p>

        <ul>
          <li>
            <code>id</code> <em>Optional string</em>.
            <span>The connection's unique identifier.</span>
          </li>

          <li>
            <code>metadata</code> <em>Optional dictionary</em>.
            <span>Metadata associated with the connection.</span>
          </li>

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

          <li>
            <code>strategy</code> <em>Optional string</em>.
            <span>The type of connection. For social connections,
            <code>event.connection.strategy === event.connection.name</code>.
            For enterprise connections, the strategy is
            <code>waad</code> (Windows Azure AD), <code>ad</code> (Active
            Directory/LDAP), <code>auth0</code> (database connections), and so
            on.</span>
          </li>
        </ul>
      </td>
    </tr>

    <tr>
      <td><code>event.custom\_domain</code> (Early access)</td>

      <td>
        <p>Details about the custom domain name information.</p>
        <p>Includes the following properties:</p>

        <ul>
          <li><code>domain</code> <em>String</em>. The custom domain where the authentication event occurred.</li>

          <li>
            <code>domain\_metadata</code> <em>Object</em>. Metadata associated with the custom domain.<br />
          </li>
        </ul>
      </td>
    </tr>

    <tr>
      <td>
        <p><code>event.notification</code></p>
      </td>

      <td>
        <p>Includes the following properties:</p>

        <ul>
          <li>
            <code>from</code> <em>String</em>.
            <span>The E.164 compliant phone number for the sender.</span>
          </li>

          <li>
            <code>locale</code> <em>String</em>.
            <span>The locale we rendered the message in, for example
            <code>en\_US</code>, as defined in the BCP-47 specification.</span>
          </li>

          <li>
            <code>message\_type</code> <em>String</em>.

            <p>
              The type of message that is being sent, like
              <code>otp\_verify</code> or <code>blocked\_account</code>.
            </p>

            <p>Possible values include:</p>

            <ul>
              <li><code>otp\_verify</code></li>
              <li><code>otp\_enroll</code></li>
              <li><code>blocked\_account</code></li>
              <li><code>change\_password</code></li>
              <li><code>password\_breach</code></li>
            </ul>
          </li>

          <li>
            <code>recipient</code> <em>String</em>.
            <span>The E.164 compliant phone number for the recipient.</span>
          </li>

          <li>
            <code>delivery\_method</code> <em>Enum</em>.
            <span>The way the message should be delivered. Could be <code>text</code> or <code>voice</code>.</span>
          </li>

          <li>
            <code>code</code> <em>String</em>.
            <span>The One-Time Password for some <code>message\_types</code> (e.g. <code>otp\_verify</code>, <code>otp\_enroll</code>).</span>
          </li>

          <li>
            <code>as\_text</code> <em>String</em>.
            <span>The rendered text ready to be delivered as a text message.</span>
          </li>

          <li>
            <code>as\_voice</code> <em>String</em>.
            <span>The rendered text ready to be delivered as a voice text message.</span>
          </li>
        </ul>
      </td>
    </tr>

    <tr>
      <td>
        <p><code>event.organization</code></p>
        <p><em>(Optional)</em></p>
      </td>

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

        <p>Includes the following properties:</p>

        <ul>
          <li>
            <code>display\_name</code> <em>String</em>.
            <span>The friendly name of the Organization.</span>
          </li>

          <li>
            <code>id</code> <em>String</em>.
            <span>The Organization identifier.</span>
          </li>

          <li>
            <code>metadata</code> <em>Dictionary</em>.
            <span>Metadata associated with the Organization.</span>
          </li>

          <li>
            <code>name</code> <em>String</em>.
            <span>The name of the Organization.</span>
          </li>
        </ul>
      </td>
    </tr>

    <tr>
      <td>
        <p><code>event.request</code></p>
        <p><em>(Optional)</em></p>
      </td>

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

        <ul>
          <li>
            <code>geoip</code> <em>Optional object</em>.
            <p>Includes the following properties:</p>

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

          <li>
            <code>ip</code> <em>Optional string</em>.
            <span>The originating IP address of the request.</span>
          </li>

          <li>
            <code>hostname</code> <em>Optional string</em>.
            <span>The hostname that is being used for the authentication flow.</span>
          </li>

          <li>
            <code>method</code> <em>Optional string</em>.
            <span>The HTTP method used for the request.</span>
          </li>

          <li>
            <code>language</code> <em>Optional string</em>.
            <span>The language requested by the browser.</span>
          </li>

          <li>
            <code>user\_agent</code> <em>Optional string</em>.
            <span>The value of the <code>User-Agent</code> header received when
            initiating the transaction.</span>
          </li>
        </ul>
      </td>
    </tr>

    <tr>
      <td>
        <p><code>event.tenant</code></p>
      </td>

      <td>
        <p>Includes the following properties:</p>

        <ul>
          <li>
            <code>friendly\_name</code> <em>Optional string</em>.
            <span>The friendly name for the tenant, usually a more human-readable
            version of the ID.</span>
          </li>

          <li>
            <code>home\_url</code> <em>Optional string</em>.
            <span>The home URL for the tenant, if defined and as found in its
            settings.</span>
          </li>

          <li>
            <code>id</code> <em>String</em>.
            <span>The name of the tenant.</span>
          </li>

          <li>
            <code>logo\_url</code> <em>Optional string</em>.
            <span>The logo URL for the tenant, if defined and as found in its
            settings.</span>
          </li>

          <li>
            <code>support\_email</code> <em>Optional string</em>.
            <span>The email to the tenant's support service, if defined and as
            found in its settings.</span>
          </li>

          <li>
            <code>support\_url</code> <em>Optional string</em>.
            <span>The url to the tenant's support service, if defined and as found
            in its settings.</span>
          </li>
        </ul>
      </td>
    </tr>

    <tr>
      <td>
        <p><code>event.user</code></p>
      </td>

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

        <p>Includes the following properties:</p>

        <ul>
          <li>
            <code>app\_metadata</code> <em>Dictionary</em>.
            <span>Custom fields that store information about a user that influences the
            user's access, such as support plan, security roles, or access
            control groups.</span>
          </li>

          <li>
            <code>email</code> <em>Optional string</em>.
            <span>(unique) User's email address.</span>
          </li>

          <li>
            <code>email\_verified</code> <em>Boolean</em>.
            <span>Indicates whether the user has verified their email
            address.</span>
          </li>

          <li>
            <code>family\_name</code> <em>Optional string</em>.
            <span>User's family name.</span>
          </li>

          <li>
            <code>given\_name</code> <em>Optional string</em>.
            <span>User's given name.</span>
          </li>

          <li>
            <code>name</code> <em>Optional string</em>.
            <span>User's full name.</span>
          </li>

          <li>
            <code>nickname</code> <em>Optional string</em>.
            <span>User's nickname.</span>
          </li>

          <li>
            <code>picture</code> <em>Optional string</em>.
            <span>URL pointing to the
            <a href="/docs/manage-users/user-accounts/change-user-picture">user's profile picture</a>.</span>
          </li>

          <li>
            <code>user\_id</code> <em>String</em>.
            <span>(unique) User's unique identifier.</span>
          </li>

          <li>
            <code>user\_metadata</code> <em>Dictionary</em>.
            <span>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.</span>
          </li>

          <li>
            <code>username</code> <em>Optional string</em>.
            <span>(unique) User's username.</span>
          </li>
        </ul>
      </td>
    </tr>
  </tbody>
</table>