How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Auth0 event-streams API

The event-streams API from Auth0 — 7 operation(s) for event-streams.

Auth0 event-streams API is one of 76 APIs that Auth0 publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Event Streams. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and an AsyncAPI specification.

This API exposes 10 operations across 7 paths, and defines 45 schemas. It is described by OpenAPI 3.2.0, at version 2.0.

Requests are made against a single base URL, https://{tenantDomain}/api/v2.

10 operations 7 paths 45 schemas 1 DELETE4 GET1 PATCH4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0
Base URL
https://your-tenant.auth0.com/api/v2
Authentication
HTTP Bearer, OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 2

Auth0 event-streams API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (jwt) (bearerAuth). It supports OAuth 2.0 (oAuth2ClientCredentials) using the clientCredentials flow, exposing 221 scopes. By default, every request must be authenticated.

Paths & Operations 10

Across 7 paths, the API surfaces 10 operations — 1 DELETE, 4 GET, 1 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.

event-streams 10
GET
/event-streams
Get Event Streams
get_event-streams 2 params → 200400401403429
POST
/event-streams
Create an Event Stream
post_event-streams body → 201400401403409429
GET
/event-streams/{id}
Get an Event Stream by ID
get_event-streams_by_id 1 param → 200401403404429
DELETE
/event-streams/{id}
Delete an Event Stream
delete_event-streams_by_id 1 param → 204400401403429
PATCH
/event-streams/{id}
Update an Event Stream
patch_event-streams_by_id 1 param body → 200400401403429
GET
/event-streams/{id}/deliveries
Get This Event Stream's Delivery History
get_event_deliveries 7 params → 200400401403404429
GET
/event-streams/{id}/deliveries/{event_id}
Get a Specific Event's Delivery History
get_deliveries_by_event_id 2 params → 200401403404429
POST
/event-streams/{id}/redeliver
Redeliver Failed Events
post_redeliver 1 param body → 202401403404409429
POST
/event-streams/{id}/redeliver/{event_id}
Redeliver a Single Failed Event by ID
post_redeliver_by_event_id 2 params → 202401403404409429
POST
/event-streams/{id}/test
Send a Test Event to an Event Stream
post_test_event 1 param body → 202401403429

Schemas 45

The contract defines 45 schemas that model the data the API accepts and returns. The most detailed are EventStreamActionResponseContent (7 properties), EventStreamEventBridgeResponseContent (7 properties), EventStreamWebhookResponseContent (7 properties), GetEventStreamDeliveryHistoryResponseContent (6 properties). Each schema is shown below with its type and property counts.

EventStreamWebhookBasicAuth
object
Basic Authorization for HTTP requests (e.g., 'Basic credentials').
2 properties 2 required
CreateEventStreamActionRequestContent
object
4 properties 1 required
EventStreamEventTypeEnum
string
EventStreamActionDestination
object
2 properties 2 required
EventStreamCloudEvent
object
Event content. This will only be set if delivery failed.
6 properties
EventStreamDeliveryStatusEnum
string
Delivery status
TestEventDataContent
object
The raw payload of the test event.
EventStreamActionResponseContent
object
7 properties
EventStreamWebhookBasicAuthMethodEnum
string
Type of authorization.
EventStreamWebhookDestinationTypeEnum
string
EventStreamTestEventTypeEnum
string
The type of event this test event represents.
EventStreamWebhookDestination
object
2 properties 2 required
EventStreamWebhookBearerAuthMethodEnum
string
Type of authorization.
EventStreamEventBridgeAWSRegionEnum
string
AWS Region for EventBridge destination.
EventStreamEventBridgeResponseContent
object
7 properties
EventStreamDestinationPatch
CreateEventStreamEventBridgeRequestContent
object
4 properties 1 required
UpdateEventStreamResponseContent
EventStreamResponseContent
CreateEventStreamRedeliveryResponseContent
object
4 properties
EventStreamDeliveryAttempt
object
3 properties 2 required
EventStreamActionDestinationTypeEnum
string
EventStreamEventBridgeConfiguration
object
Configuration specific to an eventbridge destination.
3 properties 2 required
CreateEventStreamTestEventResponseContent
object
Metadata about a specific attempt to deliver an event
6 properties 5 required
EventStreamWebhookCustomHeaderAuth
object
Custom header authorization for HTTP requests.
2 properties 2 required
EventStreamWebhookConfiguration
object
Configuration specific to a webhook destination.
2 properties 2 required
CreateEventStreamTestEventRequestContent
object
The payload for sending a test event to an event stream.
2 properties 1 required
EventStreamWebhookAuthorizationResponse
EventStreamWebhookBearerAuth
object
Bearer Authorization for HTTP requests (e.g., 'Bearer token').
1 property 1 required
EventStreamDelivery
object
Metadata about a specific attempt to deliver an event
6 properties 5 required
EventStreamWebhookCustomHeaderAuthMethodEnum
string
Type of authorization.
ListEventStreamsResponseContent
object
2 properties
EventStreamEventBridgeDestinationTypeEnum
string
EventStreamWebhookResponseContent
object
7 properties
UpdateEventStreamRequestContent
object
4 properties
EventStreamSubscription
object
Event types
1 property
EventStreamEventBridgeDestination
object
2 properties 2 required
EventStreamDeliveryEventTypeEnum
string
Type of event
CreateEventStreamResponseContent
GetEventStreamDeliveryHistoryResponseContent
object
Metadata about a specific attempt to deliver an event
6 properties 5 required
EventStreamActionConfiguration
object
Configuration specific to an action destination.
1 property 1 required
GetEventStreamResponseContent
CreateEventStreamWebHookRequestContent
object
4 properties 1 required
CreateEventStreamRedeliveryRequestContent
object
4 properties
EventStreamStatusEnum
string
Indicates whether the event stream is actively forwarding events.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

auth0-event-streams-api-openapi.yml Raw ↑

Other APIs Auth0 publishes across the network.

Auth0 My Account API
Auth0 My Organization API
Auth0 for AI Agents
Auth0 actions API
Auth0 anomaly API
Auth0 Assertions API
Auth0 attack-protection API
Auth0 Authorization Models API
Auth0 Authorize User API
Auth0 AuthZenService API
Auth0 branding API
Auth0 client-grants API
Where this information came from

This is an independent, third-party profile of Auth0 event-streams API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.