diff --git a/website/content/docs/concepts/events.mdx b/website/content/docs/concepts/events.mdx index e8c5d7e6ce3c..6506a6bdb609 100644 --- a/website/content/docs/concepts/events.mdx +++ b/website/content/docs/concepts/events.mdx @@ -17,6 +17,12 @@ and subscribers (Vault components and external users via the API). + + +Event types without the `data_path` metadata field require a root token in order to be consumed from the `/v1/sys/events/subscribe/{eventType}` API endpoint. + + + Internal components of Vault as well as external plugins can generate event notifications. These are published to "event types", sometimes called "topics" in other event systems. All event notifications of a specific event type will have the same format for their @@ -131,6 +137,17 @@ Here is an example event notification in JSON format: ## Subscribing to event notifications + + +For multi-node Vault deployments, Vault only accepts subscriptions on the active node. If a client attempts to subscribe to events on a standby node, +Vault will respond with a redirect to the active node. Vault uses the [`api_addr`](/vault/docs/configuration#api_addr) of the active node's configuration to route the redirect. + +Vault deployments with performance replication must subscribe to events on the +primary performance cluster. Vault ignores subscriptions made from secondary +clusters. + + + Vault has an API endpoint, `/v1/sys/events/subscribe/{eventType}`, that allows users to subscribe to event notifications via a WebSocket stream. This endpoint supports the standard authentication and authorization workflows used by other Vault endpoints.