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

Notify as CloudEvent #19

Open
tsutomi opened this issue Apr 24, 2023 · 0 comments
Open

Notify as CloudEvent #19

tsutomi opened this issue Apr 24, 2023 · 0 comments
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed sender Issue related to the send capability
Milestone

Comments

@tsutomi
Copy link
Member

tsutomi commented Apr 24, 2023

Currently, the Deveel.Webhooks library supports webhook notifications in a variety of formats, including JSON and XML.

This feature request is to add support for CloudEvents, a standard format for describing event data in a common way. CloudEvents make it easier to build event-driven systems that are interoperable across different platforms and services.

Background: Webhooks are a mechanism for notifying an application or service about events that occur in another application or service. They are commonly used for integrating third-party services and applications with each other. However, there is no standard format for webhook payloads, which can make it difficult to integrate different services and applications. In response to this problem, the Cloud Native Computing Foundation (CNCF) created the CloudEvent standard in 2018. CloudEvents provide a way to describe event data in a common format, making it easier to build event-driven systems that can work with different services and platforms.

Expected Deliverables - The contributor will need to modify the Deveel.Webhooks library to support CloudEvents as a notification format. This will involve adding a new class to handle CloudEvent payloads, as well as modifying the existing webhook notification code to use the CloudEvent format when requested. The contributor will also need to update the library documentation to reflect the new capability.

Difficulty Level - Moderate - The contributor will need to have some familiarity with the CloudEvent standard and how it is used. However, there are plenty of resources available to help them understand the standard and how to use it.

Resources - The following resources may be helpful for the contributor:

Contact Information: If you have any questions or need guidance, please reach out to me at [antonello at deveel dot com].

@tsutomi tsutomi added enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed sender Issue related to the send capability labels Apr 24, 2023
@tsutomi tsutomi added this to the Popeye milestone Jan 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed sender Issue related to the send capability
Projects
None yet
Development

No branches or pull requests

1 participant