This endpoint implements a soft-delete operation for webhooks. The record is retained for 48h with status=deleted before being pruned.

Endpoint: /api.propelus.com/v2/webhooks/{webhookId}

Source: https://propelus.com/developer/webhooks/DeleteWebhookById

Authentication

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"
  }
})

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.

400 — Bad Request

{
  "status": 400,
  "code": "missing_fields",
  "detail": "string",
  "errors": [
    {
      "detail": "string",
      "pointer": "string",
      "parameter": "string",
      "header": "string",
      "code": "string"
    }
  ]
}

401 — Unauthorized

{
  "status": 400,
  "code": "missing_fields",
  "detail": "string",
  "errors": [
    {
      "detail": "string",
      "pointer": "string",
      "parameter": "string",
      "header": "string",
      "code": "string"
    }
  ]
}

403 — Forbidden

{
  "status": 400,
  "code": "missing_fields",
  "detail": "string",
  "errors": [
    {
      "detail": "string",
      "pointer": "string",
      "parameter": "string",
      "header": "string",
      "code": "string"
    }
  ]
}

404 — Not Found

{
  "status": 400,
  "code": "missing_fields",
  "detail": "string",
  "errors": [
    {
      "detail": "string",
      "pointer": "string",
      "parameter": "string",
      "header": "string",
      "code": "string"
    }
  ]
}

429 — Rate Limited

{
  "status": 429,
  "detail": "string",
  "code": "f5d62b05-370e-48be-a755-8675ca146431"
}

4XX — Client Error

{
  "status": 400,
  "code": "missing_fields",
  "detail": "string",
  "errors": [
    {
      "detail": "string",
      "pointer": "string",
      "parameter": "string",
      "header": "string",
      "code": "string"
    }
  ]
}

5XX — Server Error

{
  "status": 500,
  "detail": "string",
  "code": "unexpected_error"
}