Delete a webhook endpoint

DELETE/v1/webhook_endpoints/{id}

Stops all deliveries to the endpoint, including pending retries. Events stay in the event log.

Permissions: Secret key with webhooks:manage.

Guide

Webhooks

Path parameters#

idstring (uuid)Required

Response fields#

Returns 204 with no body.

DELETE/v1/webhook_endpoints/{id}

1
2curl -X DELETE https://api.unplugdining.com/v1/webhook_endpoints/1c7f4a9e-3d2b-4f86-a5e1-8b0d6c3f9e72 \
  -H "Authorization: Bearer $UNPLUG_KEY"

1
2
3
4
5
6
7const response = await fetch("https://api.unplugdining.com/v1/webhook_endpoints/1c7f4a9e-3d2b-4f86-a5e1-8b0d6c3f9e72", {
  method: "DELETE",
  headers: {
    Authorization: `Bearer ${process.env.UNPLUG_KEY}`,
  },
});
console.log(response.status);

1
2
3
4
5
6
7
8
9
10import os
import requests

response = requests.delete(
    "https://api.unplugdining.com/v1/webhook_endpoints/1c7f4a9e-3d2b-4f86-a5e1-8b0d6c3f9e72",
    headers={
        "Authorization": f"Bearer {os.environ['UNPLUG_KEY']}",
    },
)
print(response.status_code)

Response JSON204

1(no body)

Error descriptions#

404Not found

not_found

No endpoint with this id in this environment.

Any endpoint can also return the common errors.

404 Not found

1
2
3
4
5
6
7{
  "type": "https://docs.unplugdining.com/reference/errors#not_found",
  "title": "Not found",
  "status": 404,
  "code": "not_found",
  "detail": "No endpoint with this id in this environment."
}