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

Add Webhook support on data updates #157

Open
TypicallyThomas opened this issue Mar 12, 2025 · 1 comment
Open

Add Webhook support on data updates #157

TypicallyThomas opened this issue Mar 12, 2025 · 1 comment
Labels
contribution enhancement New feature or request

Comments

@TypicallyThomas
Copy link

I would like to contribute to the API by implementing a webhook system that can notify subscribed apps that an update to the database has happened, instead of requiring apps to make request after request to check if the API has been updated. Not all apps would benefit from this, but if there are any apps that only need data when an update has occurred, a webhook system is far more efficient.

Let me know if you would like my contribution on this

@TypicallyThomas TypicallyThomas changed the title [Feature] [Contribution] [Feature] [Contribution] Webhooks Mar 12, 2025
@jolpica jolpica added enhancement New feature or request contribution labels Mar 12, 2025
@jolpica jolpica changed the title [Feature] [Contribution] Webhooks Add Webhook support on data updates Mar 12, 2025
@jolpica
Copy link
Owner

jolpica commented Mar 12, 2025

This is something I'd consider after we've run through a few rounds of data imports to ensure our processes are ironed out.

Could you expand a bit more on some details of your proposal?
For example, what sort of use case this will be useful for and how it'd make working with the API better for consumers?
What extra processing and/or tooling if any would need to be added to the API?

One thing I'm wary of is that we have some pretty heavy caching on common endpoints, so I'm concerned that we may not gain any efficiency from implementing this as a single user not using a webhook would have similar performance impact to everyone not using it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contribution enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants