Delete Webhook

DELETE

https://platform-api.convirza.com/v3/webhooks/{id}

Webhooks

Last modified:2026-07-24 13:10:44

Soft-deletes a webhook and immediately stops all event delivery to its endpoint.

What happens on delete

Webhook status changes to deleted

Event delivery stops immediately

Configuration and delivery history are preserved for audit purposes

Deletion timestamp (deleted_at) and user (deleted_by) are recorded

Important notes

This is a soft delete; data remains in the database

Deleted webhooks cannot be reactivated; create a new webhook instead

Alternative to deletion
To temporarily pause delivery while preserving the ability to reactivate:

Use PATCH /webhooks/:id with { "webhook_status": "inactive" }

Reactivate later with { "webhook_status": "active" }

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Responses

🟢200

application/json

Webhook deleted successfully

Bodyapplication/json

🟠400

🟠401

🟠404

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff --request DELETE 'https://platform-api.convirza.com/v3/webhooks/{id}' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "code": 200,
    "message": "Resource deleted successfully",
    "data": null,
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2026-03-29T12:00:00.000Z"
}

Modified at 2026-07-24 13:10:44

Partial Update Webhook

List Prompts