API reference Webhooks and events Update a webhook endpoint

Update a webhook endpoint

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

Changes the address, the events or the description, or pauses and resumes the endpoint. A paused endpoint keeps its events and gets them when it resumes; enabling a disabled one starts it again.

Scope webhooks:write
Idempotent with Idempotency-Key
Works while the store is suspended

Path parameters

idstring required

Body

application/json0 required, 4 optional

urlstring A public https addressUp to 2,048 characters
descriptionstring For you, up to 200 charactersUp to 200 characters
events"all" or array of enums "all" (now and later), or a list of event typesallorder.paidorder.fulfilledorder.refundeddispute.createdstock.lowlicense.activated
statusenum Pause or resume; enable a disabled endpoint againenabledpaused

Headers

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

Example

as_live_ or as_test_

curl -X PATCH \
  https://api.anyshop.io/v1/webhook_endpoints/whe_01m3rs9d2f4k6m8p0r2t4v6x8z \
  -H "Authorization: Bearer $ANYSHOP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "events": [
      "order.paid"
    ]
  }'

{
  "object": "webhook_endpoint",
  "id": "whe_01m3rs9d2f4k6m8p0r2t4v6x8z",
  "url": "https://api.pixelforge-supply.com/anyshop",
  "description": "",
  "livemode": false,
  "events": [
    "order.paid"
  ],
  "signing": "hmac",
  "status": "enabled",
  "disabled_reason": null,
  "failing_since": "2026-10-02T14:21:07.000Z",
  "created_at": "2026-10-02T14:21:07.000Z"
}

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.

Returns

The webhook_endpoint object.

Errors

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