Skip to main content
DELETE
/
v1
/
partner
/
webhooks
/
{id}
Delete a webhook
curl --request DELETE \
  --url https://api.hypermid.io/v1/partner/webhooks/{id} \
  --header 'X-API-Key: <api-key>'
{
  "data": {
    "id": "whk_abc123def456",
    "deleted": true
  },
  "error": null,
  "meta": {
    "requestId": "b8e9f0a1-b2c3-4567-1234-678901234567",
    "timestamp": 1711234586,
    "rateLimit": {
      "limit": 2000,
      "remaining": 1972,
      "reset": 1711234627
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.hypermid.io/llms.txt

Use this file to discover all available pages before exploring further.

Deletes a webhook endpoint. After deletion, no further events will be delivered to this URL.
​
id
string
required
The webhook ID to delete (e.g., whk_abc123def456).
{
  "data": {
    "id": "whk_abc123def456",
    "deleted": true
  },
  "error": null,
  "meta": {
    "requestId": "b8e9f0a1-b2c3-4567-1234-678901234567",
    "timestamp": 1711234586,
    "rateLimit": {
      "limit": 2000,
      "remaining": 1972,
      "reset": 1711234627
    }
  }
}

const result = await client.deleteWebhook("whk_abc123def456");
console.log("Deleted:", result.data.deleted);

Authorizations

​
X-API-Key
string
header
required

Partner API key. Optional for public endpoints, required for /v1/partner/*.

Path Parameters

​
id
string
required

Webhook ID

Response

Webhook deleted

​
data
any
required

Response payload (null on error)

​
error
object
required
​
meta
object
required