List Webhook Event Types

Use this endpoint to retrieve the deterministic inventory of event types accepted in webhook registrations. Use these values to populate the eventTypes field when creating or patching a registration.

GET /v1/webhooks/event-types

List Webhook Event Types

cURL

curl --request GET \
  --url https://api.example.com/v1/webhooks/event-types \
  --header 'Authorization: Bearer <token>'

200

eventTypes

{ "eventTypes": [ "payment_initiation.created", "transfer.completed", "transfer.rejected" ] }

Autorizaciones

BearerAuthOAuth2ClientCredentialsOAuth2Password

Authorization · string · header · requerido

JWT Bearer token authentication. The tenantId is derived from the bearer token or authenticated request context and is not supplied through X-Organization-Id.

Scopes

api · OAuth2ClientCredentials

TED transfer API access

api · OAuth2Password

TED transfer API access

Respuesta

200

application/json

Indicates that the supported event types are returned.

eventTypes · string[] · requerido

The deterministic inventory of event types accepted in webhook registrations.

Ejemplo:

[
  "payment_initiation.created",
  "transfer.completed",
  "transfer.rejected"
]