Skip to main content
POST
/
v1
/
webhooks
/
keys
/
{key_id}
/
deactivate
Deactivate a webhook encryption key
curl --request POST \
  --url http://127.0.0.1:8787/v1/webhooks/keys/{key_id}/deactivate \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "id": "<string>",
    "webhook_endpoint_id": "<string>",
    "key_id": "<string>",
    "algorithm": "<string>",
    "key_type": "<string>",
    "jwk": {},
    "is_active": true,
    "created_at": "<string>",
    "updated_at": "<string>",
    "disabled_at": "<string>"
  },
  "error": null
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
key_id
string
required

The ID of the webhook encryption key to deactivate (e.g. whk_...).

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$

Response

Webhook encryption key deactivated.

​
data
object
required
​
error
null
required