awatertrevi/infisical
1
0
Fork 0
mirror of https://github.com/awatertrevi/infisical.git synced 2026-10-07 13:27:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: content

Browse Source
This commit is contained in:
sidwebworks
2025-08-02 18:26:21 +05:30
parent 9ee2581659
commit 9fde0a5787
1 changed files with 37 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/documentation/platform/event-subscriptions.mdx
+37 -25
View File
@@ -1,20 +1,28 @@
--- ---
title: "Event Subscriptions" title: "Event Subscriptions"
sidebarTitle: "Events" sidebarTitle: "Events"
description: "Subscribe to events in Infisical in real-time" description: "Subscribe to events in Infisical for real-time updates"
--- ---
<Info> <Info>
<strong>Note:</strong> Event Subscriptions is a paid feature.<br /><br /> <strong>Note:</strong> Event Subscriptions is a paid feature.
On Infisical Cloud, this feature is available on the <strong>Pro</strong> and <strong>Enterprise</strong> tiers, each providing different event retention periods.<br /> <br />
For self-hosted deployments, please contact <a href="mailto:[email protected]">[email protected]</a> to purchase an enterprise license. <br />
On Infisical Cloud, this feature is available on the <strong>
Pro
</strong> and <strong>Enterprise</strong> tiers, with each tier providing
different event retention periods.
<br />
For self-hosted deployments, please contact{" "}
<a href="mailto:[email protected]">[email protected]</a> to purchase an
enterprise license.
</Info> </Info>
## Introduction ## 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 ### Supported Event Types
@@ -24,7 +32,7 @@ Currently, you can subscribe to notifications for the following event types:
## Permissions Setup ## 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:
<Steps> <Steps>
<Step title="Select a project and copy the 'Project ID'"> <Step title="Select a project and copy the 'Project ID'">
@@ -34,28 +42,30 @@ Proper permissions are required for configuring event subscriptions. To set up t
`https://app.infisical.com/project/<your_project_id>/settings` `https://app.infisical.com/project/<your_project_id>/settings`
</Step> </Step>
<Step title="Navigate to 'Access Management' and open 'Project Roles'"> <Step title="Navigate to 'Access Management' and open 'Project Roles'">
![Project Detail](/images/platform/events/project-detail.png) ![Project Detail](/images/platform/events/project-detail.png) ![Project
![Project Access](/images/platform/events/project-access.png) Access](/images/platform/events/project-access.png) Navigate to{" "}
Go to <strong>Access Management</strong>, then select <strong>Project Roles</strong>. <strong>Access Management</strong>, then select <strong>Project Roles</strong>
</Step> .
</Step>
<Step title="Select an existing role or create a new one"> <Step title="Select an existing role or create a new one">
![Project Role](/images/platform/events/project-role.png) ![Project Role](/images/platform/events/project-role.png) You can either edit
You can either edit an existing role or create a new role for event subscriptions. an existing role or create a new role for event subscriptions.
</Step> </Step>
<Step title="Assign policies to the role"> <Step title="Assign policies to the role">
![Role Detail](/images/platform/events/role-detail.png) ![Role Detail](/images/platform/events/role-detail.png) Select the specific
Choose the specific resources that the role should have access to.<br /> resources that the role should have access to.
![Add policy](/images/platform/events/add-policy.png) <br />
</Step> ![Add policy](/images/platform/events/add-policy.png)
</Step>
<Step title="Enable the 'Subscribe' action in permissions"> <Step title="Enable the 'Subscribe' action in permissions">
![Policy setting](/images/platform/events/policy-setting.png) ![Policy setting](/images/platform/events/policy-setting.png)
Make sure the <strong>Subscribe</strong> action is selected for the relevant resources and events.<br /> Ensure the <strong>Subscribe</strong> action is selected for the relevant resources and events.<br />
<AccordionGroup> <AccordionGroup>
<Accordion title="Add conditions to your permission"> <Accordion title="Add conditions to your permissions">
By default, the role will have access to all events for the selected resources in this project. 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.<br /> If needed, you can add filters to limit the scope of accessible events.<br />
![Policy setting](/images/platform/events/add-conditions.png) ![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.<br /> **Note:** Only users or roles with appropriate permissions can manage or subscribe to events.<br />
<strong>Availability:</strong> Event Subscriptions are not included in the Free plan.
<strong>Availability:</strong> Event Subscriptions are not available on the Free
plan.