Delete an endpoint

DELETE/v1/webhooks/{id}Key scope write

Deletes a webhook endpoint and its delivery log. Deliveries still pending for it are not sent, and listing or replaying its deliveries answers 404 afterwards.

Needs a key with the write scope. Authentication

curl -X DELETE https://api.useinfrared.com/v1/webhooks/whe_2HLyVEWQelwo16welH16NM \
  -H "Authorization: Bearer $INFRARED_KEY"

const response = await fetch("https://api.useinfrared.com/v1/webhooks/whe_2HLyVEWQelwo16welH16NM", {
  method: "DELETE",
  headers: { Authorization: `Bearer ${process.env.INFRARED_KEY}` },
});

const data = await response.json();

import os
import requests

response = requests.delete(
    "https://api.useinfrared.com/v1/webhooks/whe_2HLyVEWQelwo16welH16NM",
    headers={"Authorization": f"Bearer {os.environ['INFRARED_KEY']}"},
)

data = response.json()

200 OKResponse

{
  "deleted": true,
  "id": "whe_2HLyVEWQelwo16welH16NM"
}

Path parameters

idstringRequired: Id of the endpoint: whe_ plus 22 base62 characters.

Returns

An object with deleted set to true and the id of the deleted endpoint.

200 OKAn object

Errors

404: not_found
The key's project has no webhook endpoint with this id.

Every endpoint can also answer the errors any request can meet: a missing key, a rate limit, a malformed body. Errors

Something missing or unclear on this page? Write to support@useinfrared.com.