Dashboard

Webhooks

Retire signing key

Retire a secondary key without promoting it. The primary key cannot be retired; promote a replacement instead.

POSThttps://api.sndr.sh/v1/webhooks/{id}/signing-keys/{key_id}/retire
Retire signing key
curl -X POST 'https://api.sndr.sh/v1/webhooks/wh_2a7d4e9c-6b1/signing-keys/whk_61d0a9c7-5e4/retire' \
  -H "Authorization: Bearer $SNDR_API_KEY"
200OK
{
  "id":     "whk_61d0a9c7-5e4",
  "status": "retired"
}

Authorization

Authorizationstringheaderrequired

Bearer followed by your API key. Needs the send scope.

Path parameters

idstringrequired

Webhook ID (wh_...).

key_idstringrequired

Secondary key ID (whk_...).

Errors

401unauthenticatedMissing or invalid API key.
403insufficient_scopeThe API key is missing the send scope.
404not_foundResource does not exist or belongs to a different account.
409conflictThe key is not a secondary key (it is the primary or already retired).