Make Webhook Event types an enum in the Admin API #2786
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
Context
We should properly define an
enum
for the differentWebhookEvent
types (incoming_payment.created
,outgoing_payment.completed
, etc...) in the GraphQL backend Admin API. This enum would be used inWebhookEvent.type
, similar to howIncomingPaymentState
is defined forIncomingPayment
s.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
The text was updated successfully, but these errors were encountered: