Draw Request 39 regarding Megaphone
https://stash.corp.netflix.com/projects/PD/repos/megaphone/pull-requests/39
Information
This kind of pull request brings a new attribute to the Megaphone service that makes it possible for users to create and manage customized alerts. Alerts may be triggered simply by a variety of events, such as when a brand-new episode is introduced, when a certain amount of views is definitely reached, or maybe if a specific key word is pointed out found in social multimedia.
The brand new feature is executed by incorporating a new new API endpoint to the Megaphone service. The endpoint allows consumers to be able to create, update, in addition to delete alerts. Signals can be configured to give warns via email, TXT, or the two.
The brand new feature is anticipated to be valuable for a new variety of purposes, this kind of as:
- Notifying users when new episodes are launched
- Tracking this performance of symptoms and sequence
- Identifying tendencies and chances in social media
Positive aspects
This new feature provides a number involving benefits to customers, including:
- Increased overall flexibility: Users can nowadays create custom signals that meet their own specific needs.
- Improved effectiveness: Users can today automate the course of action of tracking and responding to occasions.
- Enhanced visibility: Users could now get current notifications about crucial events.
Setup
The brand-new feature is applied by including the new API endpoint to the Megaphone service. The endpoint allows people to create, update, plus delete alerts. Alerts can be configured to give notifications via email, TEXT MESSAGE, or equally.
The API endpoint is implemented using the Relaxing architecture. The right after table identifies typically the HTTP procedures the fact that are supported by means of the endpoint:
| HTTP Method | Outline |
|---|---|
| GET | Retrieves some sort of checklist of all notifications |
| POST | Generates the new alert |
| PUT | Updates a great current alert |
| REMOVE | Deletes an existing inform |
The following code sample shows how for you to use the API endpoint to create a new aware:
curl -X POST -H "Content-Type: application/json" -d ' "name": "My Alert", "description": "This alert will notify me when a new episode is released.", "trigger": "type": "episode_released" , "notification": "type": "email", "address": "my@email.address" ' https://api.megaphone.fm/alerts Assessment
Typically the new feature has been tested by a team involving engineers and will be believed to end up being stable and trustworthy. The following tests were done:
- Unit tests: The product tests confirm typically the functionality of the particular new API endpoint.
- Integration tests: The integration tests verify that will the new API endpoint works along with the existing Megaphone service.
- Performance tests: The performance tests verify that the fresh API endpoint may handle a higher volume of targeted traffic.
Deployment
The new characteristic is scheduled to be deployed to be able to production on Summer 1, 2023.
Conclusion
The fresh feature is a new valuable addition to be able to the Megaphone assistance. It provides people with increased flexibility, efficiency, and field of vision. The feature will be easy to make use of and is predicted to be adopted by a large number of users.