Skip to content

Commit 1145a44

Browse files
duedares-rvjduedares-rvj
authored
feat: Add support for Events:Test triggers, deliveries, redeliver and stats (#1288)
* feat: Add support for Events:Test triggers, deliveries, redeliver and stats * lint * Updated code * Updated docs * minor docs update * updated events to event-streams * Updated auth0 events to auth0 event-streams * Updated docs
1 parent e4531e2 commit 1145a44

30 files changed

+1932
-435
lines changed

‎docs/auth0_event-streams.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
layout: default
3+
has_toc: false
4+
has_children: true
5+
---
6+
# auth0 event-streams
7+
8+
Events are a way for Auth0 customers to synchronize, correlate or orchestrate changes that occur within Auth0 or 3rd-party identity providers to your app or 3rd party services.
9+
10+
## Commands
11+
12+
- [auth0 event-streams create](auth0_event-streams_create.md) - Create a new event stream
13+
- [auth0 event-streams delete](auth0_event-streams_delete.md) - Delete an event stream
14+
- [auth0 event-streams deliveries](auth0_event-streams_deliveries.md) - Manage event stream deliveries
15+
- [auth0 event-streams list](auth0_event-streams_list.md) - List your event streams
16+
- [auth0 event-streams redeliver](auth0_event-streams_redeliver.md) - Retry one or more event deliveries for a given stream
17+
- [auth0 event-streams redeliver-many](auth0_event-streams_redeliver-many.md) - Bulk retry failed event deliveries using filters
18+
- [auth0 event-streams show](auth0_event-streams_show.md) - Show an event stream
19+
- [auth0 event-streams stats](auth0_event-streams_stats.md) - View delivery stats for an event stream
20+
- [auth0 event-streams trigger](auth0_event-streams_trigger.md) - Trigger a test event for an event stream
21+
- [auth0 event-streams update](auth0_event-streams_update.md) - Update an event stream
22+

‎docs/auth0_event-streams_create.md‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
layout: default
3+
parent: auth0 event-streams
4+
has_toc: false
5+
---
6+
# auth0 event-streams create
7+
8+
Create a new event stream.
9+
10+
To create interactively, use `auth0 event-streams create` with no flags.
11+
12+
To create non-interactively, supply the event stream name, type, subscriptions and configuration through the flags.
13+
14+
## Usage
15+
```
16+
auth0 event-streams create [flags]
17+
```
18+
19+
## Examples
20+
21+
```
22+
auth0 event-streams create
23+
auth0 event-streams create --name my-event-stream --type eventbridge --subscriptions "user.created,user.updated" --configuration '{"aws_account_id":"325235643634","aws_region":"us-east-2"}'
24+
auth0 event-streams create --name my-event-stream --type webhook --subscriptions "user.created,user.deleted" --configuration '{"webhook_endpoint":"https://mywebhook.net","webhook_authorization":{"method":"bearer","token":"123456789"}}'
25+
auth0 event-streams create -n my-event-stream -t webhook -s "user.created,user.deleted" -c '{"webhook_endpoint":"https://mywebhook.net","webhook_authorization":{"method":"bearer","token":"123456789"}}'
26+
```
27+
28+
29+
## Flags
30+
31+
```
32+
-c, --configuration string Configuration of the Event Stream. Formatted as JSON.
33+
Webhook Example: {"webhook_endpoint":"https://my-webhook.net","webhook_authorization":{"method":"bearer","token":"123456789"}}
34+
Eventbridge Example: {"aws_account_id":"7832467231933","aws_region":"us-east-2"}
35+
--json Output in json format.
36+
--json-compact Output in compact json format.
37+
-n, --name string Name of the Event Stream.
38+
-s, --subscriptions strings Subscriptions of the Event Stream. Formatted as comma separated string. Eg. user.created,user.updated
39+
-t, --type string Type of the Event Stream. Eg: webhook, eventbridge etc
40+
```
41+
42+
43+
## Inherited Flags
44+
45+
```
46+
--debug Enable debug mode.
47+
--no-color Disable colors.
48+
--no-input Disable interactivity.
49+
--tenant string Specific tenant to use.
50+
```
51+
52+
53+
## Related Commands
54+
55+
- [auth0 event-streams create](auth0_event-streams_create.md) - Create a new event stream
56+
- [auth0 event-streams delete](auth0_event-streams_delete.md) - Delete an event stream
57+
- [auth0 event-streams deliveries](auth0_event-streams_deliveries.md) - Manage event stream deliveries
58+
- [auth0 event-streams list](auth0_event-streams_list.md) - List your event streams
59+
- [auth0 event-streams redeliver](auth0_event-streams_redeliver.md) - Retry one or more event deliveries for a given stream
60+
- [auth0 event-streams redeliver-many](auth0_event-streams_redeliver-many.md) - Bulk retry failed event deliveries using filters
61+
- [auth0 event-streams show](auth0_event-streams_show.md) - Show an event stream
62+
- [auth0 event-streams stats](auth0_event-streams_stats.md) - View delivery stats for an event stream
63+
- [auth0 event-streams trigger](auth0_event-streams_trigger.md) - Trigger a test event for an event stream
64+
- [auth0 event-streams update](auth0_event-streams_update.md) - Update an event stream
65+
66+

‎docs/auth0_event-streams_delete.md‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
---
2+
layout: default
3+
parent: auth0 event-streams
4+
has_toc: false
5+
---
6+
# auth0 event-streams delete
7+
8+
Delete an event stream.
9+
10+
To delete interactively, use `auth0 event-streams delete` with no arguments.
11+
12+
To delete non-interactively, supply the event id and the `--force` flag to skip confirmation.
13+
14+
## Usage
15+
```
16+
auth0 event-streams delete [flags]
17+
```
18+
19+
## Examples
20+
21+
```
22+
auth0 event-streams delete
23+
auth0 event-streams rm
24+
auth0 event-streams delete <event-id>
25+
auth0 event-streams delete <event-id> --force
26+
auth0 event-streams delete <event-id> <event-id2> <event-idn>
27+
auth0 event-streams delete <event-id> <event-id2> <event-idn> --force
28+
```
29+
30+
31+
## Flags
32+
33+
```
34+
--force Skip confirmation.
35+
```
36+
37+
38+
## Inherited Flags
39+
40+
```
41+
--debug Enable debug mode.
42+
--no-color Disable colors.
43+
--no-input Disable interactivity.
44+
--tenant string Specific tenant to use.
45+
```
46+
47+
48+
## Related Commands
49+
50+
- [auth0 event-streams create](auth0_event-streams_create.md) - Create a new event stream
51+
- [auth0 event-streams delete](auth0_event-streams_delete.md) - Delete an event stream
52+
- [auth0 event-streams deliveries](auth0_event-streams_deliveries.md) - Manage event stream deliveries
53+
- [auth0 event-streams list](auth0_event-streams_list.md) - List your event streams
54+
- [auth0 event-streams redeliver](auth0_event-streams_redeliver.md) - Retry one or more event deliveries for a given stream
55+
- [auth0 event-streams redeliver-many](auth0_event-streams_redeliver-many.md) - Bulk retry failed event deliveries using filters
56+
- [auth0 event-streams show](auth0_event-streams_show.md) - Show an event stream
57+
- [auth0 event-streams stats](auth0_event-streams_stats.md) - View delivery stats for an event stream
58+
- [auth0 event-streams trigger](auth0_event-streams_trigger.md) - Trigger a test event for an event stream
59+
- [auth0 event-streams update](auth0_event-streams_update.md) - Update an event stream
60+
61+

‎docs/auth0_event-streams_deliveries.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
layout: default
3+
has_toc: false
4+
has_children: true
5+
---
6+
# auth0 event-streams deliveries
7+
8+
Inspect and monitor delivery attempts for triggered events in a given event stream.
9+
10+
## Commands
11+
12+
- [auth0 event-streams deliveries list](auth0_event-streams_deliveries_list.md) - List failed deliveries for an event stream
13+
- [auth0 event-streams deliveries show](auth0_event-streams_deliveries_show.md) - Show details for a specific delivery
14+

‎docs/auth0_event-streams_deliveries_list.md‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
layout: default
3+
parent: auth0 event-streams deliveries
4+
has_toc: false
5+
---
6+
# auth0 event-streams deliveries list
7+
8+
List all failed delivery attempts associated with a specific event stream.
9+
Optionally filter by event type(s) using the --type flag.
10+
11+
## Usage
12+
```
13+
auth0 event-streams deliveries list [event-stream-id] [flags]
14+
```
15+
16+
## Examples
17+
18+
```
19+
auth0 event-streams deliveries list
20+
auth0 event-streams deliveries list <event-stream-id>
21+
auth0 event-streams deliveries list <event-stream-id> --type user.created
22+
auth0 event-streams deliveries list --json
23+
auth0 event-streams deliveries list --csv
24+
auth0 event-streams deliveries list --picker
25+
```
26+
27+
28+
## Flags
29+
30+
```
31+
--csv Output in CSV format.
32+
-f, --from string Filter deliveries from this date (e.g. 2025-07-25, yesterday, -2d)
33+
--json Output in JSON format.
34+
-n, --n int Number of results to return, defaults to 50 (default 50)
35+
-p, --picker Allows to toggle from list of events and view a selected event in detail
36+
-t, --to string Filter deliveries up to this date (e.g. 2025-07-29, today)
37+
--type strings Filter deliveries by one or more event types (comma-separated)
38+
```
39+
40+
41+
## Inherited Flags
42+
43+
```
44+
--debug Enable debug mode.
45+
--no-color Disable colors.
46+
--no-input Disable interactivity.
47+
--tenant string Specific tenant to use.
48+
```
49+
50+
51+
## Related Commands
52+
53+
- [auth0 event-streams deliveries list](auth0_event-streams_deliveries_list.md) - List failed deliveries for an event stream
54+
- [auth0 event-streams deliveries show](auth0_event-streams_deliveries_show.md) - Show details for a specific delivery
55+
56+

‎docs/auth0_event-streams_deliveries_show.md‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
layout: default
3+
parent: auth0 event-streams deliveries
4+
has_toc: false
5+
---
6+
# auth0 event-streams deliveries show
7+
8+
Displays metadata, attempts, and event payload for a specific
9+
delivery associated with an event stream.
10+
If stream ID or delivery ID is not provided, you will be prompted to select them interactively.
11+
12+
## Usage
13+
```
14+
auth0 event-streams deliveries show [stream-id] [delivery-id] [flags]
15+
```
16+
17+
## Examples
18+
19+
```
20+
auth0 event-streams deliveries show
21+
auth0 event-streams deliveries show <stream-id>
22+
auth0 event-streams deliveries show <stream-id> <delivery-id>
23+
```
24+
25+
26+
## Flags
27+
28+
```
29+
--json Output in json format.
30+
```
31+
32+
33+
## Inherited Flags
34+
35+
```
36+
--debug Enable debug mode.
37+
--no-color Disable colors.
38+
--no-input Disable interactivity.
39+
--tenant string Specific tenant to use.
40+
```
41+
42+
43+
## Related Commands
44+
45+
- [auth0 event-streams deliveries list](auth0_event-streams_deliveries_list.md) - List failed deliveries for an event stream
46+
- [auth0 event-streams deliveries show](auth0_event-streams_deliveries_show.md) - Show details for a specific delivery
47+
48+

‎docs/auth0_event-streams_list.md‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
layout: default
3+
parent: auth0 event-streams
4+
has_toc: false
5+
---
6+
# auth0 event-streams list
7+
8+
List your existing event streams. To create one, run: `auth0 event-streams create`.
9+
10+
## Usage
11+
```
12+
auth0 event-streams list [flags]
13+
```
14+
15+
## Examples
16+
17+
```
18+
auth0 event-streams list
19+
auth0 event-streams ls
20+
auth0 event-streams ls --json
21+
auth0 event-streams ls --json-compact
22+
auth0 event-streams ls --csv
23+
```
24+
25+
26+
## Flags
27+
28+
```
29+
--csv Output in csv format.
30+
--json Output in json format.
31+
--json-compact Output in compact json format.
32+
```
33+
34+
35+
## Inherited Flags
36+
37+
```
38+
--debug Enable debug mode.
39+
--no-color Disable colors.
40+
--no-input Disable interactivity.
41+
--tenant string Specific tenant to use.
42+
```
43+
44+
45+
## Related Commands
46+
47+
- [auth0 event-streams create](auth0_event-streams_create.md) - Create a new event stream
48+
- [auth0 event-streams delete](auth0_event-streams_delete.md) - Delete an event stream
49+
- [auth0 event-streams deliveries](auth0_event-streams_deliveries.md) - Manage event stream deliveries
50+
- [auth0 event-streams list](auth0_event-streams_list.md) - List your event streams
51+
- [auth0 event-streams redeliver](auth0_event-streams_redeliver.md) - Retry one or more event deliveries for a given stream
52+
- [auth0 event-streams redeliver-many](auth0_event-streams_redeliver-many.md) - Bulk retry failed event deliveries using filters
53+
- [auth0 event-streams show](auth0_event-streams_show.md) - Show an event stream
54+
- [auth0 event-streams stats](auth0_event-streams_stats.md) - View delivery stats for an event stream
55+
- [auth0 event-streams trigger](auth0_event-streams_trigger.md) - Trigger a test event for an event stream
56+
- [auth0 event-streams update](auth0_event-streams_update.md) - Update an event stream
57+
58+

‎docs/auth0_event-streams_redeliver-many.md‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
layout: default
3+
parent: auth0 event-streams
4+
has_toc: false
5+
---
6+
# auth0 event-streams redeliver-many
7+
8+
Retry multiple failed event deliveries for a given event stream.
9+
You can filter by event type and date range.
10+
All filters are combined using AND logic.
11+
If no filters are passed, all failed events are retried
12+
13+
## Usage
14+
```
15+
auth0 event-streams redeliver-many [stream-id] [flags]
16+
```
17+
18+
## Examples
19+
20+
```
21+
auth0 event-streams redeliver-many
22+
auth0 event-streams redeliver-many <stream-id>
23+
auth0 event-streams redeliver-many <stream-id> --type=user.created,user.deleted --from=-2d
24+
```
25+
26+
27+
## Flags
28+
29+
```
30+
-f, --from string Start date for filtering (e.g. 2025-07-25, -2d, yesterday)
31+
-t, --to string End date for filtering (e.g. 2025-07-29, today)
32+
--type string Comma-separated event types (e.g. user.created,user.deleted)
33+
```
34+
35+
36+
## Inherited Flags
37+
38+
```
39+
--debug Enable debug mode.
40+
--no-color Disable colors.
41+
--no-input Disable interactivity.
42+
--tenant string Specific tenant to use.
43+
```
44+
45+
46+
## Related Commands
47+
48+
- [auth0 event-streams create](auth0_event-streams_create.md) - Create a new event stream
49+
- [auth0 event-streams delete](auth0_event-streams_delete.md) - Delete an event stream
50+
- [auth0 event-streams deliveries](auth0_event-streams_deliveries.md) - Manage event stream deliveries
51+
- [auth0 event-streams list](auth0_event-streams_list.md) - List your event streams
52+
- [auth0 event-streams redeliver](auth0_event-streams_redeliver.md) - Retry one or more event deliveries for a given stream
53+
- [auth0 event-streams redeliver-many](auth0_event-streams_redeliver-many.md) - Bulk retry failed event deliveries using filters
54+
- [auth0 event-streams show](auth0_event-streams_show.md) - Show an event stream
55+
- [auth0 event-streams stats](auth0_event-streams_stats.md) - View delivery stats for an event stream
56+
- [auth0 event-streams trigger](auth0_event-streams_trigger.md) - Trigger a test event for an event stream
57+
- [auth0 event-streams update](auth0_event-streams_update.md) - Update an event stream
58+
59+

0 commit comments

Comments
 (0)