post https://api.banking.netevia.dev/api/Partners/webhooks
Description:
This API method allows a partner to create and register a new webhook with the banking application service. Webhooks enable partners to receive real-time notifications about specific banking events, such as transaction updates, account changes, or payment statuses. By registering a webhook, the partner defines a destination URL and the type of events they want to be notified about.
Endpoint:
POST https://api.banking.netevia.dev/api/Partners/webhooks
Functionality:
- Purpose: To set up a webhook that listens for specific events and sends automated notifications to a partner's system.
- Use Case: Partners use this endpoint to stay synchronized with the banking system in real time (e.g., alerting a merchant when a transaction is completed or a payment fails).
Request Headers:
Authorization: Bearer token required (partner-level authentication).Content-Type:application/json
Request Body Parameters:
{
"name": "Transaction Notifications",
"url": "https://partner.example.com/webhooks/transactions",
"notificationType": "transaction.created"
}| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes | A descriptive name for the webhook; must be between 1 and 50 characters. |
url | uri | Yes | The fully qualified URL where webhook events will be sent (HTTPS preferred). |
notificationType | string | Yes | The type of event to subscribe to (e.g., transaction.created, account.updated). |
Response:
- 201 Created: Webhook successfully created.
- 400 Bad Request: Missing or invalid parameters (e.g., name too long, invalid URL).
- 401 Unauthorized: Invalid or missing authentication token.
- 409 Conflict: A webhook with the same URL and event type already exists.
- 500 Internal Server Error: An error occurred while creating the webhook.
Example Request:
POST /api/Partners/webhooks HTTP/1.1
Host: api.banking.netevia.dev
Authorization: Bearer {partnerToken}
Content-Type: application/json
{
"name": "Transaction Notifications",
"url": "https://partner.example.com/webhooks/transactions",
"notificationType": "transaction.created"
}Notes:
- Security: It is recommended to use HTTPS URLs and implement verification of incoming requests (e.g., via signature headers or token validation).
- Webhook Events: The
notificationTypefield defines which system event triggers the webhook. - Management: Use related endpoints to update (
GET) or delete (DELETE) the webhook as needed.
This API provides a simple and secure way for partners to receive timely updates and automate backend workflows based on real-time banking events.