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

Introduce a custom AsyncAPI extension to incorporate signature verification for webhook payloads #7568

Open
chathushkaayash opened this issue Feb 10, 2025 · 0 comments

Comments

@chathushkaayash
Copy link

chathushkaayash commented Feb 10, 2025

Description

When addressing the issue providing a way to configure the HTTP Listener configurations in the AsyncAPI-generated listeners, we need to consider additional fields that can be included in ListenerConfiguration. Typically, this includes tokens related to webhook signature verification.

Problem Statement

In the ListenerConfiguration of the Ballerina asyncapi-triggers, certain fields are typically required to handle webhook signature verification. These fields often include secrets or tokens used for verifying incoming webhook requests. However, the current Ballerina service and listener skeleton generation process does not allow us to specify these tokens or the verification process in the AsyncAPI specification.

Current Workaround

Since there is no way to define these additional configurations in the generated listener, we currently:

  • Manually extend the ListenerConfiguration to include the necessary tokens.
  • Implement the signature verification logic manually within the generated service.

Proposed Solution

To make webhook signature verification more seamless, we should introduce a way to define these additional configurations directly in the AsyncAPI specification. One potential approach is to utilize custom extensions in the AsyncAPI spec to define signature verification tokens and have them reflected in the generated Ballerina listener.

@chathushkaayash chathushkaayash changed the title Support Additional Listener Configuration Fields in Async API Generated Listeners Introduce a custom AsyncAPI extension to incorporate signature verification for webhook payloads Feb 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants