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

Make Webhook Event types an enum in the Admin API #2786

Open
2 tasks
mkurapov opened this issue Jun 26, 2024 · 0 comments · May be fixed by #3025
Open
2 tasks

Make Webhook Event types an enum in the Admin API #2786

mkurapov opened this issue Jun 26, 2024 · 0 comments · May be fixed by #3025
Assignees
Labels
breaking Issue/PR that introduces breaking changes pkg: backend Changes in the backend package. pkg: frontend Changes in the frontend package. pkg: mock-ase

Comments

@mkurapov
Copy link
Contributor

mkurapov commented Jun 26, 2024

Context

We should properly define an enum for the different WebhookEvent types (incoming_payment.created, outgoing_payment.completed, etc...) in the GraphQL backend Admin API. This enum would be used in WebhookEvent.type, similar to how IncomingPaymentState is defined for IncomingPayments.

This will provide better clarity in the documentation, and allow consumers of the GraphQL (e.g. MASE) use auto generated TypeScript types for defining the webhooks, instead of having to declare it's own interface.

Todos

  • Update the GraphQL Admin API schema
  • Update the consumers of the API (MASE, as well as the frontend)
@sabineschaller sabineschaller added the pkg: backend Changes in the backend package. label Jul 25, 2024
@mkurapov mkurapov changed the title Add Webhook Enum to Admin API Make Webhook Event types an enum in the Admin API Jul 25, 2024
@mkurapov mkurapov added pkg: frontend Changes in the frontend package. pkg: mock-ase labels Jul 25, 2024
@sabineschaller sabineschaller self-assigned this Aug 1, 2024
@mkurapov mkurapov added the breaking Issue/PR that introduces breaking changes label Sep 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking Issue/PR that introduces breaking changes pkg: backend Changes in the backend package. pkg: frontend Changes in the frontend package. pkg: mock-ase
Projects
Status: Ready for Review
3 participants