Events Catalog Overview - Auth0 Docs
Event Notifications
Events are real-time notifications about specific actions – initially changes to a user and organizations, but eventually others – that have occurred within your Auth0 tenant. You can create event streams that listen for these events to orchestrate asynchronous changes (i.e., changes to an entity or flow that have been completed) in Auth0 and forward them to one of many destinations for external processing. Events support a variety of use cases, including:
- Sending emails to new customers to welcome them or ask them to verify their email address.
- Monitoring user lifecycle changes so that you can update CRM (customer relationship management) or billing systems.
Event Object Schema
Events are published using a schema that conforms to the CloudEvent specification:
| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | Yes | Identifies the event. |
| source | URI-reference | Yes | Identifies the tenant that generated the event, including its environment. |
| specversion | string | Yes | The version of the CloudEvents specification that the event uses. |
| type | string | Yes | The type of event. |
| time | timestamp | Yes | Timestamp of when the event happened. |
| dataschema | URI | Yes | Identifies the schema that data adheres to. |
| data | object | Yes | Additional information related to the event. This field varies based on the type of event. |
{
"id": "evt_<unique-id>",
"source": "urn:auth0:<your-tenant>:users",
"specversion": "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>"
}
}
}
Resources
| Read… | To learn… |
|---|---|
| Create an Event Stream | How to get started with an Event Stream. |
| Event Testing, Observability, and Failure Recovery | How to test and manage your active event streams. |
| Events Best Practices | Best practices for working with events. |