Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement "Webhooks" feature for event notifications #361

Open
ravisuhag opened this issue Sep 24, 2023 · 1 comment
Open

Implement "Webhooks" feature for event notifications #361

ravisuhag opened this issue Sep 24, 2023 · 1 comment

Comments

@ravisuhag
Copy link
Member

Frontier currently lacks a mechanism for real-time event notification, which is crucial for monitoring and responding to activities within the system. To enhance the platform's observability and integrability, we propose implementing a "Webhooks" feature that allows users to receive notifications for all events occurring within their IAM accounts.

Problem Statement:
Without a robust event notification system, users may miss critical activities or security incidents within their IAM accounts. Webhooks are a widely adopted method for delivering real-time event notifications to external systems, making them a valuable addition to our platform.

Proposed Solution:
We propose implementing the "Webhooks" feature, which will enable users to subscribe to specific events and receive HTTP callbacks to their specified endpoints whenever those events occur.

Functional Requirements:

  • Event Subscription: Users should be able to subscribe to a wide range of events within their IAM accounts, including login attempts, role changes, access requests, and more.
  • Webhook Configuration: Users should be able to configure webhook endpoints, including the URL, authentication, and payload format.
  • Event Payload: Webhook notifications should include detailed event information, such as the event type, timestamp, and relevant user or resource details.
  • Retry Mechanism: Implement a retry mechanism to ensure the delivery of webhook notifications even in case of network or endpoint failures.

Security Considerations:

  • Ensure secure transmission of event data to webhook endpoints.
  • Implement authentication and authorization for webhook subscriptions and notifications.
  • Provide mechanisms to revoke or disable webhook subscriptions.

User Interface and CLI:
We need to design a user-friendly interface within the IAM platform that allows users to configure webhook subscriptions and manage their webhook endpoints easily.

Testing:
Thorough testing, including unit tests, integration tests, and security testing, should be conducted to ensure the feature works reliably and securely.

Documentation:
User documentation should be provided to guide users on how to set up and use webhooks effectively, including best practices for handling webhook notifications.

Acceptance Criteria:

  • Users can subscribe to various events within their IAM accounts.
  • Users can configure webhook endpoints with the necessary details.
  • Webhook notifications include detailed event information.
  • A retry mechanism ensures the reliable delivery of webhook notifications.
  • Security considerations are addressed, and notifications are securely transmitted.
  • Comprehensive testing is completed.
  • User documentation is available.

Additional Information:
The "Webhooks" feature will significantly improve the observability and integrability of our IAM platform, allowing users to stay informed about critical events and seamlessly integrate the IAM system with external monitoring and response tools. It will empower users to take proactive actions based on real-time event data.

@ravisuhag
Copy link
Member Author

@anujk14 @kushsharma Can we check is this issue is fully implemented? Also please link related PRs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: 2024
Development

No branches or pull requests

2 participants