API reference Webhooks and events Rotate the signing secret

Rotate the signing secret

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

A new signing secret, shown once in the answer. The old one signs next to it for 24 hours, so your server can switch without missing a delivery.

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

Path parameters

idstring required

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 POST \
  https://api.anyshop.io/v1/webhook_endpoints/whe_01m3rs9d2f4k6m8p0r2t4v6x8z/rotate_secret \
  -H "Authorization: Bearer $ANYSHOP_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

{
  "object": "webhook_secret",
  "algorithm": "hmac",
  "value": "whsec_Q3s9mV1dGx7PqL2nW8rT5kZ0bY4cH6jF9aE1uS3oKP4="
}

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_secret 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