API reference Webhooks and events Delete a webhook endpoint

Delete a webhook endpoint

DEL methodhttps://api.anyshop.io/v1/webhook_endpoints/{id}

Removes the endpoint and its delivery log. Events are kept 30 days, so a new endpoint can replay them.

Path parameters

Idempotency-Keystring Up to 255 characters. A retry with the same key and request gets the first answer, without running twice (24 hours).

as_live_ or as_test_

curl -X DELETE \
  https://api.anyshop.io/v1/webhook_endpoints/whe_01m3rs9d2f4k6m8p0r2t4v6x8z \
  -H "Authorization: Bearer $ANYSHOP_API_KEY"

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

The IDs and keys in these examples are made up. Every schema is in the OpenAPI document, served at https://api.anyshop.io/v1/openapi.json.

An object with object, id and deleted.

Status and error.type

400invalid_requestThe request is not valid; error.param names the field
401authenticationNo API key, or it is not valid
403permissionThe key does not have the scope this needs, it is a test key where only a live key may act (the catalog), or the store is suspended (store_suspended)
404not_foundNot found in the key's store and mode
409conflictConflicts with the object's state (type conflict), or an Idempotency-Key reused for another request (type idempotency, code idempotency_key_reused)
429rate_limitedToo many requests; see Retry-After