Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions main/config/navigation/customize.json
Original file line number Diff line number Diff line change
Expand Up @@ -347,8 +347,9 @@
},
{
"group": "Events",
"directory": "accordion",
"root": "docs/customize/events",
"pages": [
"docs/customize/events",
"docs/customize/events/event-types",
"docs/customize/events/create-an-event-stream",
"docs/customize/events/consume-events-with-events-api",
Expand All @@ -357,7 +358,8 @@
"pages": [
"docs/customize/events/sync-data-across-systems",
"docs/customize/events/correlate-identity-changes",
"docs/customize/events/orchestrate-business-workflows"
"docs/customize/events/orchestrate-business-workflows",
"docs/customize/events/send-outbound-scim"
]
},
"docs/customize/events/event-testing-observability-and-failure-recovery",
Expand Down
29 changes: 4 additions & 25 deletions main/docs/customize/events.mdx
Original file line number Diff line number Diff line change
@@ -1,31 +1,10 @@
---
description: Learn more about using Events for Auth0
sidebarTitle: Overview
title: Events
description: Use real-time notifications of events on your Auth0 tenant to orchestrate changes to external apps or third-party services.
---

Events offer Auth0 customers an API-based method of synchronizing, correlating, or orchestrating changes that occur within Auth0 or 3rd-party <Tooltip tip="Identity Provider (IdP): Service that stores and manages digital identities." cta="View Glossary" href="/docs/glossary?term=identity+providers">identity providers</Tooltip> (IdPs) to external apps or 3rd-party services.
Events are real-time notifications about specific actions that have occurred within your Auth0 tenant. You can use events in two ways:

<Callout icon="file-lines" color="#0EA5E9" iconType="regular">
By enabling Event streams, the customer becomes the controller of such information and is responsible for the data exported from the Auth0 Platform, including what information is streamed and how it is used.
</Callout>
* **Event streams**: Create event streams that execute on specific events to orchestrate asynchronous changes in Auth0 (like changes to a user or a flow that has completed) and forward them for external processing.

## Use cases

Events are real-time notifications about specific actions – initially changes to a user, 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:

* **[Synchronize data across systems](/docs/customize/events/sync-data-across-systems)** — Keep an external database, data warehouse, or search index synchronized with identity changes in Auth0.
* **[Correlate identity changes with external systems](/docs/customize/events/correlate-identity-changes)** — React to identity changes and propagate updates to CRM platforms, billing services, or SaaS licensing tools.
* **[Orchestrate business workflows](/docs/customize/events/orchestrate-business-workflows)** — Fan out identity changes to multiple downstream systems, such as a CRM and a notification channel, in a single workflow.

## Resources

To get started with Events, review the following:

| Read... | To learn... |
| --- | --- |
| [Event Types](/docs/customize/events/event-types) | How to work with supported event types. |
| [Create an Event Stream](/docs/customize/events/create-an-event-stream) | How to create an Event Stream with AWS EventBridge or webhooks. |
| [Consume Events with the Events API](/docs/customize/events/consume-events-with-events-api) | How to pull events from Auth0 using the SSE-based Events API. |
| [Event Testing, Observability, and Failure Recovery](/docs/customize/events/event-testing-observability-and-failure-recovery) | How to test and manage your active event streams. |
| [Events Best Practices](/docs/customize/events/events-best-practices) | Best practices for working with events. |
* **The Events API**: Receive events as Server-Sent Events (SSE) stream as a pull-based alternative to event streams.
4 changes: 4 additions & 0 deletions main/docs/customize/events/create-an-event-stream.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ By subscribing to events, and delivering them to a destination of your choice us

You can create an event stream using either AWS EventBridge or webhooks. The sections below outline the setup process for both options.

<Callout icon="file-lines" color="#0EA5E9" iconType="regular">
By enabling event streams, the customer becomes the controller of such information and is responsible for the data exported from the Auth0 Platform, including what information is streamed and how it is used.
</Callout>

## Access Management API (optional)

Event streams can either be provisioned using the <Tooltip tip="Auth0 Dashboard: Auth0's main product to configure your services." cta="View Glossary" href="/docs/glossary?term=Auth0+dashboard">Auth0 dashboard</Tooltip> or the [Auth0 Management API](https://auth0.com/docs/api/management/v2). If using the <Tooltip tip="Management API: A product to allow customers to perform administrative tasks." cta="View Glossary" href="/docs/glossary?term=Management+API">Management API</Tooltip>, before you can set up an event stream, you need to create a machine-to-machine (M2M) application and authenticate with a Management API token. For more information, review [Management API Access Tokens](/docs/secure/tokens/access-tokens/management-api-access-tokens).
Expand Down
3 changes: 1 addition & 2 deletions main/docs/customize/events/event-types.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
description: Learn more about supported Event types.
title: Event Types
description: View the Event object schema for supported event types.
---

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.
Expand Down Expand Up @@ -62,7 +62,6 @@ Events are published using a schema that conforms to the [CloudEvent specificati

For more information on Event Types, see the [Events Catalog](https://auth0.com/docs/events/).


## Learn more

* [Create an Event Stream](/docs/customize/events/create-an-event-stream)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
description: Trigger downstream business workflows across multiple systems when identity changes occur in Auth0.
title: Orchestrate Business Workflows
description: Trigger downstream business workflows across multiple systems, such as a CRM and a notification channel, when identity changes occur in Auth0.
---

With Event Streams and Auth0 Actions, you can turn identity lifecycle changes into automated business workflows that span multiple systems. When a user is created, updated, or deleted in Auth0, an Action runs server-side code that calls external APIs in parallel, meaning you can build complete pipelines without deploying your own middleware.
Expand Down
Loading
Loading