feat(webhooks & callbacks): add contracts for generic HMAC implementation #105
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…rspective" This reverts commit 426171d.
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive webhook and callback support to the Python core library by introducing a templating system for flexible message construction and an HMAC signature verification system. The implementation provides a framework-agnostic approach to handling webhook events with secure signature verification capabilities.
- Introduces a template engine with JSON Pointer support for flexible message construction from HTTP requests
- Implements configurable HMAC signature verification with multiple hash algorithms and encoding options
- Adds comprehensive test coverage for all new components including edge cases and error handling
Reviewed Changes
Copilot reviewed 16 out of 20 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| apimatic_core/templating/template_engine.py | Core templating engine for parsing and rendering message templates with runtime expressions |
| apimatic_core/templating/template_resolver.py | Built-in resolvers for extracting HTTP method, URL, headers, query params, and JSON body data |
| apimatic_core/templating/json_pointer_resolver.py | RFC 6901 JSON Pointer implementation for extracting values from JSON request bodies |
| apimatic_core/security/hmac_signature_verifier.py | HMAC signature verification with configurable templates, hash algorithms, and encoders |
| apimatic_core/security/encoders.py | Digest encoding implementations (hex, base64, base64url) |
| apimatic_core/exceptions/signature_verification_error.py | Custom exception for signature verification failures |
| tests/ | Comprehensive test suites covering all new functionality with edge cases |
| setup.py | Version bump to 0.2.22 |
| README.md | Updated documentation with new templating and security features |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
sufyankhanrao
changed the title
sufyankhanrao
force-pushed
the
webhooks-support
branch
2 times, most recently
from
6142f23 to
9b78914
Compare
sufyankhanrao
force-pushed
the
webhooks-support
branch
from
9b78914 to
e803faf
Compare
sufyankhanrao
force-pushed
the
webhooks-support
branch
3 times, most recently
from
b391792 to
db79796
Compare
sufyankhanrao
force-pushed
the
webhooks-support
branch
from
db79796 to
98621d9
Compare
…the signature verification package inside security
|
asadali214
approved these changes
Oct 3, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What
Why
To establish a solid foundation for Webhooks and Callbacks in the Python core library.
These additions provide secure, consistent handling of webhook events across SDKs while ensuring extensibility for future enhancements.
Closes #104
Type of change
Select multiple if applicable.
Dependency Change
If a new dependency is being added, please ensure that it adheres to the following guideline https://github.com/apimatic/apimatic-codegen/wiki/Policy-of-adding-new-dependencies-in-the-core-libraries
Breaking change
If the PR is introducing a breaking change, please ensure that it adheres to the following guideline https://github.com/apimatic/apimatic-codegen/wiki/Guidelines-for-maintaining-core-libraries
Testing
List the steps that were taken to test the changes
Checklist