Skip to content

Conversation

@haseeb-mhr
Copy link
Contributor

@haseeb-mhr haseeb-mhr commented Sep 16, 2025

What

What
Add webhooks and callbacks support in the Java SDK, enabling users to register, configure, and handle webhook/callback events directly through the SDK.

Why

Provides seamless event-driven integration with external systems and improves developer experience by supporting standardized webhook and callback mechanisms.

Type of change

Select multiple if applicable.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause a breaking change)
  • Tests (adds or updates tests)
  • Documentation (adds or updates documentation)
  • Refactor (style improvements, performance improvements, code refactoring)
  • Revert (reverts a commit)
  • CI/Build (adds or updates a script, change in external dependencies)

Dependency Change

No new dependencies are added.

Breaking change

No breaking changes are introduced in this PR.

Testing

No new tests are added, as none exist for this area yet.

Checklist

  • My code follows the coding conventions
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have added new unit tests

@haseeb-mhr haseeb-mhr self-assigned this Sep 16, 2025
@haseeb-mhr haseeb-mhr added the enhancement New feature or request label Sep 16, 2025
@haseeb-mhr haseeb-mhr force-pushed the feat-add-webhooks-callbacks-support branch 2 times, most recently from 73c27af to 653af60 Compare September 16, 2025 08:46
@apimatic apimatic deleted a comment from sonarqubecloud bot Sep 16, 2025
@haseeb-mhr haseeb-mhr force-pushed the feat-add-webhooks-callbacks-support branch from 9891db7 to 653af60 Compare September 16, 2025 08:50
@apimatic apimatic deleted a comment from sonarqubecloud bot Sep 16, 2025
@haseeb-mhr haseeb-mhr marked this pull request as ready for review September 16, 2025 08:56
hamzamahmood
hamzamahmood previously approved these changes Oct 3, 2025
@sufyankhanrao sufyankhanrao requested a review from Copilot October 3, 2025 10:25
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

Adds webhooks and callbacks support to the Java SDK by introducing security verification interfaces for HTTP request signatures. This enables event-driven integration with external systems through standardized verification mechanisms.

  • Introduces VerificationResult interface for representing success/failure states with error messages
  • Adds SignatureVerifier interface for asynchronous HTTP request signature verification
  • Updates documentation to include the new security interfaces

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

File Description
src/main/java/io/apimatic/coreinterfaces/security/VerificationResult.java Defines result interface with static factory methods for success/failure states
src/main/java/io/apimatic/coreinterfaces/security/SignatureVerifier.java Provides contract for asynchronous signature verification of HTTP requests
sonar-project.properties Excludes coverage requirements for the new security interfaces
README.md Documents the new security interfaces in the core interfaces table

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

…Result.java

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@sonarqubecloud
Copy link

sonarqubecloud bot commented Oct 3, 2025

@sufyankhanrao sufyankhanrao merged commit 58d7299 into main Oct 3, 2025
7 checks passed
@sufyankhanrao sufyankhanrao deleted the feat-add-webhooks-callbacks-support branch October 3, 2025 10:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants