get https://api.banking.netevia.dev/api/Partners/webhooks
Description:
This API method retrieves a list of all webhooks registered by a partner with the banking application service. It allows partners to view the configuration of their webhooks, including event types, target URLs, and status. Webhooks are used to receive real-time notifications about specific events (e.g., transaction updates, account changes) occurring within the banking system.
Endpoint:
GET https://api.banking.netevia.dev/api/Partners/webhooks
Functionality:
- Purpose: Provides partners with a complete overview of their active and inactive webhook configurations.
- User Flow: A partner uses this API to audit, manage, or troubleshoot webhook subscriptions to ensure correct and timely event notifications.
Request Headers:
- Authorization: Bearer token required to authenticate the partner and authorize access to the webhook configurations.
- Content-Type:
application/json
Response:
-
200 OK: Returns a JSON array of webhook objects, each describing a webhook subscription set up by the partner.
-
401 Unauthorized: If the authorization token is invalid or expired.
-
500 Internal Server Error: If the server fails to retrieve the list of webhooks due to an internal error.
Example Request:
GET /api/Partners/webhooks HTTP/1.1
Host: api.banking.netevia.dev
Authorization: Bearer {partnerToken}
Content-Type: application/jsonNotes:
- Use Case: Ideal for partners needing visibility into their webhook setup or verifying webhook health/status.
- Maintenance: Partners can use this information to disable, update, or delete webhooks using related API methods (e.g.,
DELETEorPOSTendpoints). - Event Monitoring: Ensures partners stay informed in real time about critical changes or activities involving their merchant clients.