Skip to content

Conversation

Shailesh-714
Copy link
Contributor

Type of Change

  • Bugfix
  • New feature
  • Enhancement
  • Refactoring
  • Dependency updates
  • Documentation
  • CI/CD

Description

Added a webhook notifier for pre- and post-installation of hyperswitch using docker compose. This webhook sends the following API call to https://hyperswitch.gateway.scarf.sh:

  • initiated (when a user tries to install hyperswitch)
  • success (when all the components are successfully up and running)
  • error (when any of the component fails or the server is unreachable)

The API calls include information about the platform(docker/helm/cdk), version and additional information about success/failure.

Additional Changes

  • This PR modifies the API contract
  • This PR modifies the database schema
  • This PR modifies application configuration/environment variables

Motivation and Context

This change enables tracking of installation attempts, providing valuable insights into user adoption and setup experience. By monitoring success and failure rates, we can identify and resolve potential setup issues, ultimately improving user experience.

How did you test it?

  1. Create a mock server and replace the url of the mock server inplace of WEBHOOK_URL in scripts/prestart_hook.sh and scripts/poststart_hook.sh
  2. Run docker compose up -d
  3. You can verify the status responses about your installation in your mock server.
Screenshot 2025-03-26 at 7 19 16 PM

Checklist

  • I formatted the code cargo +nightly fmt --all
  • I addressed lints thrown by cargo clippy
  • I reviewed the submitted code
  • I added unit tests for my changes where possible

@Shailesh-714 Shailesh-714 requested review from a team as code owners March 27, 2025 07:41
Copy link

semanticdiff-com bot commented Mar 27, 2025

Review changes with  SemanticDiff

Changed Files
File Status
  docker-compose.yml  6% smaller
  scripts/poststart_hook.sh Unsupported file format
  scripts/prestart_hook.sh Unsupported file format

@Shailesh-714 Shailesh-714 changed the title feat(helm): add webhook notifiers for installation tracking feat(docker): add webhook notifiers for installation tracking Mar 28, 2025
@Shailesh-714 Shailesh-714 requested a review from a team as a code owner March 28, 2025 07:49
@hyperswitch-bot hyperswitch-bot bot added the M-database-changes Metadata: This PR involves database schema changes label Mar 28, 2025
@hyperswitch-bot hyperswitch-bot bot removed the M-database-changes Metadata: This PR involves database schema changes label Mar 28, 2025
@Shailesh-714 Shailesh-714 self-assigned this Mar 28, 2025
@Gnanasundari24 Gnanasundari24 added this pull request to the merge queue Apr 15, 2025
Merged via the queue into main with commit 3446c5e Apr 15, 2025
16 of 20 checks passed
@Gnanasundari24 Gnanasundari24 deleted the install-track-hook branch April 15, 2025 08:08
pixincreate added a commit that referenced this pull request Apr 15, 2025
…acilitapay-pix-pmt

* 'main' of github.com:juspay/hyperswitch:
  feat(docker): add webhook notifiers for installation tracking (#7653)
  refactor(customer): refactor customer db with storage utils and move trait to domain_models and impl to storage_model (#7538)
  feat(core): Add support for updating metadata after payment has been authorized (#7776)
  chore(version): 2025.04.14.0
  fix: script for one click docker setup (#7762)
  fix(payment_link): add validation for return_url during payment link creation (#7802)
  chore: address Rust 1.86.0 clippy lints (#7735)
  fix(connector): Add network error message support for payment connectors (#7760)
  feat(webhook): add filter by event class and type (#7275)
  ci(cypress): verify if card fields are populated on updating card info (#7743)
  chore(version): 2025.04.11.0
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants