This endpoint implements a soft-delete operation for webhooks.
The record is retained for 48h with status=deleted before being pruned.
Endpoint:
HTTP Method: DELETE
Path: /v2/webhooks/{webhookId}
Server URL: https://api.propelus.com
Developer Docs: https://propelus.com/developer/webhooks/DeleteWebhookById
Two header-based authentication methods are required:
| Header | Type | Description |
| x-api-key | token | API key credential |
| x-client-id | token | Client identifier credential |
Path Parameters
| Parameter | Type | Required | Description |
| webhookId | string (UUID) | Yes |
Unique identifier for the webhook |
Example JSON Request
fetch("https://api.propelus.com/v2/webhooks/628fc8e2-ee7e-4779-9eb7-d980e7a92f3a", {
method: "DELETE",
headers: {
"x-api-key": "bajeWgvgvK3eU0au63bzv820Vh0r0iqta7Nj3R1O",
"x-client-id": "bajeWgvgvK3eU0au63bzv820Vh0r0iqta7Nj3R1O"
}
})Example cURL Request
curl -X DELETE "https://api.propelus.com/v2/webhooks/628fc8e2-ee7e-4779-9eb7-d980e7a92f3a" \
-H "x-api-key: bajeWgvgvK3eU0au63bzv820Vh0r0iqta7Nj3R1O" \
-H "x-client-id: bajeWgvgvK3eU0au63bzv820Vh0r0iqta7Nj3R1O"Responses
200 — Success
{
"status": 200,
"code": "deleted",
"detail": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}Error Responses
The endpoint returns standardized error responses. Each error body includes a status, code, detail, and (for validation-style errors) an errors array whose items contain detail, pointer, parameter, header, and code: https://propelus.com/developer/webhooks/DeleteWebhookById#response-body
400 — Bad Request
401 — Unauthorized
403 — Forbidden
404 — Not Found
4XX — Client Error
5XX — Server Error