Skip to main content Link Menu Expand (external link) Document Search Copy Copied
Auth0 CLI

auth0 event-streams update

Update an event stream.

To update interactively, use auth0 event-streams update with no arguments.

To update non-interactively, supply the event id, name, status, subscriptions and configuration through the flags. An event stream type CANNOT be updated hence the configuration should match the schema based on the type of event stream. Configuration for eventbridge streams cannot be updated.

Usage 

auth0 event-streams update [flags]

Examples 

  auth0 event-streams update <event-id>
  auth0 event-streams update <event-id> --name my-event-stream
  auth0 event-streams update <event-id> --name my-event-stream --status enabled
  auth0 event-streams update <event-id> --name my-event-stream --status enabled --subscriptions "user.created,user.updated"
  auth0 event-streams update <event-id> --name my-event-stream --status disabled --subscriptions "user.deleted" --configuration '{"aws_account_id":"325235643634","aws_region":"us-east-2"}'
  auth0 event-streams update <event-id> --name my-event-stream --status enabled --subscriptions "user.created" --configuration '{"webhook_endpoint":"https://my-new-webhook.net","webhook_authorization":{"method":"bearer","token":"0909090909"}}
  auth0 event-streams update <event-id> -n my-event-stream --status enabled -s "user.created" -c '{"webhook_endpoint":"https://my-new-webhook.net","webhook_authorization":{"method":"bearer","token":"987654321"}}

Flags 

  -c, --configuration string    Configuration of the Event Stream. Formatted as JSON. 
                                Webhook Example: {"webhook_endpoint":"https://my-webhook.net","webhook_authorization":{"method":"bearer","token":"123456789"}} 
                                Eventbridge Example: {"aws_account_id":"7832467231933","aws_region":"us-east-2"}
      --json                    Output in json format.
      --json-compact            Output in compact json format.
  -n, --name string             Name of the Event Stream.
      --status string           Status of the Event Stream. (enabled/disabled)
  -s, --subscriptions strings   Subscriptions of the Event Stream. Formatted as comma separated string. Eg. user.created,user.updated

Inherited Flags 

      --debug           Enable debug mode.
      --no-color        Disable colors.
      --no-input        Disable interactivity.
      --tenant string   Specific tenant to use.