Skip to content

feat: add webhook support for generation completion events#213

Open
Abfa41 wants to merge 6 commits into
SATYAM-PRATIBHAN:mainfrom
Abfa41:feat/webhook-support
Open

feat: add webhook support for generation completion events#213
Abfa41 wants to merge 6 commits into
SATYAM-PRATIBHAN:mainfrom
Abfa41:feat/webhook-support

Conversation

@Abfa41
Copy link
Copy Markdown
Contributor

@Abfa41 Abfa41 commented May 24, 2026

Description

This PR adds webhook support to notify users when a system design generation completes (success or failure).

Previously, users had to wait for generation results inside the application. Now, external systems can receive real-time HTTP callbacks when a generation finishes, enabling integrations like automation tools, bots, and CI pipelines.


Type of Change

  • 🐛 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 existing functionality to not work as expected)
  • 📚 Documentation update
  • 🔧 Configuration change
  • ♻️ Refactoring (no functional changes)
  • 🎨 Style/UI changes

Related Issues

Closes #108

Features / Completed all Requirements

  • Allow users to register one or more webhook URLs (UI or API endpoint)
  • Validate webhook URLs for correctness and security (must be HTTPS, prevent internal IPs)
  • POST to registered webhook(s) with status, result, and metadata when generation completes
  • Support both success and failure notifications
  • Include signature header (e.g., HMAC) for message authenticity
  • Document webhook payload format in README or API docs
  • UI shows user's registered webhooks and delivery status/history

Screenshots ( Backend )

  • Testing all the testcases inside Postman and everything running perfectly ✔.
image
  • Used Webhook.site as eg webhook site and it worked over there successfully ✔. You can refer below image..👇
image

Screenshots ( Frontend ):

  • Followed the archmindAI Theme and made the UI for Webhook Management Webpage ✔.
image image image

Checklist

  • My code follows the project's style guidelines
  • I have performed a self-review of my code
  • I have commented my code where necessary
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have tested my changes locally
  • Any dependent changes have been merged and published

Additional Notes

  • Webhooks are triggered on both success and failure of generation.
  • Webhook calls are non-blocking to avoid delaying API response.
  • Payload includes event type, userId, and generation data.
  • Designed to support future enhancements like retries and signature verification.

@netlify
Copy link
Copy Markdown

netlify Bot commented May 24, 2026

👷 Deploy request for arcmind-ai pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit 49975b9

@Abfa41
Copy link
Copy Markdown
Contributor Author

Abfa41 commented May 24, 2026

@SATYAM-PRATIBHAN Sir, I have finally completed the feature. It took me 2 days to finish as I also had an exam during that time.

Please review my PR when you get time and let me know if any changes or improvements are required. I’ve tested the full flow including backend, frontend, and documentation.

If possible, I would be grateful if this PR could be considered under level:critical since it includes a full-stack feature implementation with backend, frontend, and documentation changes.

Thanks!

@Abfa41
Copy link
Copy Markdown
Contributor Author

Abfa41 commented May 24, 2026

Also Sir, I want to inform you before hand only that the frontend is in settings/webhooks/ url. You can put it in [protected] routes as well Sir, but I was getting issues regarding signup and that all in my local setup, thats why I put it outside separately.

@SATYAM-PRATIBHAN
Copy link
Copy Markdown
Owner

Hey @Abfa41, kindly solve the CI checks!!

@Abfa41
Copy link
Copy Markdown
Contributor Author

Abfa41 commented May 26, 2026

@SATYAM-PRATIBHAN Sir, I checked the failing CI/type-check issue. The failure is currently caused by existing unused @ts-expect-error directives already present across the project (around 70+ occurrences in multiple unrelated files), not specifically from the webhook implementation.

The TypeScript error is:
TS2578: Unused '@ts-expect-error' directive ( As you can see from below image )

image

This happens when a suppression comment exists but the actual TypeScript error no longer exists anymore, so CI fails during strict type checking.

Since most of these files are unrelated to the webhook feature/issue, I wanted to confirm first whether you would prefer handling this cleanup separately, or should I remove/fix all these unused directives within this PR itself so the CI passes, even though it would include unrelated project-wide changes outside the webhook issue scope.

If you want, we can also ignore this for this PR and handle it later separately.

@Abfa41
Copy link
Copy Markdown
Contributor Author

Abfa41 commented May 26, 2026

@SATYAM-PRATIBHAN Sir, I checked the failing CI/type-check issue. The failure is currently caused by existing unused @ts-expect-error directives already present across the project (around 70+ occurrences in multiple unrelated files), not specifically from the webhook implementation.

The TypeScript error is: TS2578: Unused '@ts-expect-error' directive ( As you can see from below image )

image This happens when a suppression comment exists but the actual TypeScript error no longer exists anymore, so CI fails during strict type checking.

Since most of these files are unrelated to the webhook feature/issue, I wanted to confirm first whether you would prefer handling this cleanup separately, or should I remove/fix all these unused directives within this PR itself so the CI passes, even though it would include unrelated project-wide changes outside the webhook issue scope.

If you want, we can also ignore this for this PR and handle it later separately.

@SATYAM-PRATIBHAN Sir, Please let me know as early as possible..

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.

[Feature] Add webhook support for generation completion notifications

2 participants