delete https://api.banking.netevia.dev/api/Partners/webhooks/
Action: Delete Partner’s Webhook
Description:
This API method allows a partner to permanently delete a specific webhook that is no longer needed. Once deleted, the webhook will stop receiving notifications for its associated event type. This is useful for cleaning up outdated endpoints, removing test configurations, or deactivating webhook delivery for security or maintenance reasons.
Endpoint:
DELETE https://api.banking.netevia.dev/api/Partners/webhooks/{id}
Functionality:
- Purpose: Removes the specified webhook from the partner’s configuration.
- Use Case: Used when a partner wants to stop receiving notifications at a particular endpoint, or when a webhook has been replaced or deprecated.
Request Headers:
Authorization
: Bearer token (required for partner authentication)Content-Type
:application/json
Path Parameters:
Parameter | Type | Required | Description |
---|---|---|---|
id | int32 | Yes | The unique identifier of the webhook to be deleted |
Example Request:
DELETE /api/Partners/webhooks/123 HTTP/1.1
Host: api.banking.netevia.dev
Authorization: Bearer {partnerToken}
Content-Type: application/json
Response Codes:
- 200 OK: Webhook was successfully deleted.
- 401 Unauthorized: Missing or invalid authentication token.
- 404 Not Found: Webhook with the given ID does not exist.
- 500 Internal Server Error: Unexpected error occurred during deletion.
Notes:
- Effect: Once deleted, no further webhook events will be sent to the specified URL.
- Irreversible: Deletion is permanent. If needed again, the webhook must be recreated using the
POST /api/Partners/webhooks
endpoint. - Best Practice: Partners should ensure that their systems no longer rely on the webhook before deleting it.