Skip to main content

Documentation Index

Fetch the complete documentation index at: https://auth0.com/llms.txt

Use this file to discover all available pages before exploring further.

You can create event streams that listen for different types of events, such as the creation of a new user profile. The sections below outline specific details for currently supported event types.

​
Event object

Events are published using a schema that conforms to the CloudEvent specification:
ParameterTypeRequiredDescription
idstringYesIdentifies the event.
sourceURI-referenceYesIdentifies the tenant that generated the event, including its environment.
specversionstringYesThe version of the CloudEvents specification that the event uses.
typestringYesThe type of event.
timetimestampYesTimestamp of when the event happened.
dataschemaURIYesIdentifies the schema that data adheres to.
dataobjectYesAdditional information related to the event. This field varies based on the type of event.
{
  "id": "evt_<unique-id>",
  "source": "urn:auth0:<your-tenant>:users",
  "spec_version": "1.0",
  "type": "com.auth0.user.<event-type>",
  "time": "2025-01-29T14:36:25.794Z",
  "dataschema": "https://<your-tenant>.auth0.com/api/v2/schemas/user.<event-type>",
  "data": {
    "object": {
      "user_id": "<user-id>",
      "email": "<email>",
      "email_verified": <true/false>,
      "family_name": "<family-name>",
      "given_name": "<given-name>",
      "name": "<full-name>",
      "nickname": "<nickname>",
      "phone_number": "<phone-number>",
      "phone_verified": <true/false>,
      "user_metadata": {
        "hobby": "<user-hobby>"
      },
      "app_metadata": {
        "external_user_id": "<external-id>"
      },
      "identities": [
        {
          "connection": "<connection-name>",
          "user_id": "<identity-user-id>",
          "provider": "<identity-provider>",
          "isSocial": <true/false>
        }
      ],
      "created_at": "<user-created-time>",
      "updated_at": "<user-updated-time>",
      "picture": "<profile-picture-url>"
    }
  }
}
For more information on Event Types, see the Events Catalog.

​
Learn more