Get webhook notififcation types

Get Webhook Notification Types

The /api/enums/webhookTypes endpoint returns a comprehensive list of all webhook notification types supported by the Netevia Banking platform. Partners use this endpoint to discover which events can trigger webhook notifications and how to configure their integration accordingly.

Endpoint

GET /api/enums/webhookTypes

Authentication

Bearer token required. Obtain via:

POST https://api.banking.netevia.dev/api/auth/v2

Include in header: Authorization: Bearer {token}
Token lifetime: 10 minutes. Refresh via POST /api/auth/refresh.

When to use

Use this endpoint when setting up or managing webhook integrations to understand which event types are available for subscription. This is a prerequisite step before registering a webhook URL, as it provides the exact event type codes needed to filter notifications. Call this endpoint whenever you need to verify supported event types or build a selection UI for partners configuring their notification preferences.

Response

200 OK

Returns an array of code/description objects, each representing a supported webhook notification type.

FieldTypeDescription
codestringThe unique identifier code for the webhook notification type
descriptionstringHuman-readable description of the webhook notification event
[
  {
    "code": "CARD_TRANSACTION",
    "description": "Triggered when a card transaction is processed"
  },
  {
    "code": "ACCOUNT_CREATED",
    "description": "Triggered when a new financial account is created"
  },
  {
    "code": "TRANSFER_COMPLETED",
    "description": "Triggered when a transfer has been completed"
  },
  {
    "code": "KYC_STATUS_UPDATED",
    "description": "Triggered when a customer KYC verification status changes"
  }
]

Error Codes

CodeWhen it happens
401Token missing, expired, or invalid
403Insufficient permissions
500Internal server error

Common Mistakes

  • Using this endpoint without a valid Bearer token — all requests require authentication even though this is a read-only enumeration endpoint.
  • Hardcoding webhook type codes in your integration without calling this endpoint first — the available types may be updated and should be fetched dynamically.

Related Endpoints

  • GET /api/enums/transferTypes — Retrieve all supported transfer type codes
  • GET /api/enums/cardTypes — Retrieve all supported card type codes
  • POST /api/webhooks — Register a webhook URL to receive event notifications

Example

curl -X GET https://api.banking.netevia.dev/api/enums/webhookTypes \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Accept: application/json"
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Response

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json