diff --git a/docs/documentation/platform/event-subscriptions.mdx b/docs/documentation/platform/event-subscriptions.mdx index af1236a84..017fd937e 100644 --- a/docs/documentation/platform/event-subscriptions.mdx +++ b/docs/documentation/platform/event-subscriptions.mdx @@ -1,20 +1,28 @@ --- title: "Event Subscriptions" sidebarTitle: "Events" -description: "Subscribe to events in Infisical in real-time" +description: "Subscribe to events in Infisical for real-time updates" --- -Note: Event Subscriptions is a paid feature.

-On Infisical Cloud, this feature is available on the Pro and Enterprise tiers, each providing different event retention periods.
-For self-hosted deployments, please contact sales@infisical.com to purchase an enterprise license. + Note: Event Subscriptions is a paid feature. +
+
+ On Infisical Cloud, this feature is available on the + Pro + and Enterprise tiers, with each tier providing + different event retention periods. +
+ For self-hosted deployments, please contact{" "} + sales@infisical.com to purchase an + enterprise license.
## Introduction -Event Subscriptions in Infisical let you receive real-time notifications when specific actions take place within your account or organization. These can include changes to secrets, users, teams, and other important resources. +Event Subscriptions in Infisical allow you to receive real-time notifications when specific actions occur within your account or organization. These notifications can include changes to secrets, users, teams, and other important resources. -Currently, you can subscribe to notifications for the following event types: +You can currently subscribe to notifications for the following event types: ### Supported Event Types @@ -24,7 +32,7 @@ Currently, you can subscribe to notifications for the following event types: ## Permissions Setup -Proper permissions are required for configuring event subscriptions. To set up the necessary permissions, follow these steps: +Proper permissions are required to configure event subscriptions. Follow these steps to set up the necessary permissions: @@ -34,28 +42,30 @@ Proper permissions are required for configuring event subscriptions. To set up t `https://app.infisical.com/project//settings` - - ![Project Detail](/images/platform/events/project-detail.png) - ![Project Access](/images/platform/events/project-access.png) - Go to Access Management, then select Project Roles. - + + ![Project Detail](/images/platform/events/project-detail.png) ![Project + Access](/images/platform/events/project-access.png) Navigate to{" "} + Access Management, then select Project Roles + . + - - ![Project Role](/images/platform/events/project-role.png) - You can either edit an existing role or create a new role for event subscriptions. - + + ![Project Role](/images/platform/events/project-role.png) You can either edit + an existing role or create a new role for event subscriptions. + - - ![Role Detail](/images/platform/events/role-detail.png) - Choose the specific resources that the role should have access to.
- ![Add policy](/images/platform/events/add-policy.png) -
+ + ![Role Detail](/images/platform/events/role-detail.png) Select the specific + resources that the role should have access to. +
+ ![Add policy](/images/platform/events/add-policy.png) +
![Policy setting](/images/platform/events/policy-setting.png) - Make sure the Subscribe action is selected for the relevant resources and events.
+ Ensure the Subscribe action is selected for the relevant resources and events.
- + By default, the role will have access to all events for the selected resources in this project. If needed, you can add filters to limit the scope of accessible events.
![Policy setting](/images/platform/events/add-conditions.png) @@ -70,5 +80,7 @@ For integration and implementation details, please refer to our [API Reference]( --- -**Note:** Only users or roles with the appropriate permissions can manage or subscribe to events.
-Availability: Event Subscriptions are not included in the Free plan. +**Note:** Only users or roles with appropriate permissions can manage or subscribe to events.
+ +Availability: Event Subscriptions are not available on the Free +plan.