Skip to content

Revoke a webhook and its signing keys

POST
/katara/v1/notification-webhooks/{id}/revoke
curl --request POST \
--url https://api.katara.com/katara/v1/notification-webhooks/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/revoke \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "version": 1 }'

Stops future delivery and revokes signing-key references. A bounded in-flight send holds a shared lock; revocation waits for that send to finish.

id
required
string format: uuid
X-Katara-Account-ID
string format: uuid
/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/

Required for cookie-authenticated changes. Use the UUID of the account that loaded the application. A different current cookie account returns account_changed before the handler runs. Session bearer and API key clients do not require this header.

Media typeapplication/json
object
version
required
integer
>= 1
Examplegenerated
{
"version": 1
}

Current subscription state. Responses are never cached.

Media typeapplication/json
object
id
required
string format: uuid
org_id
required
string format: uuid
environment_id
required
string format: uuid
reset_generation
required
integer
>= 1
mode
required
Allowed values: test live
destination
required
string format: uri
event_types
required
Array<string>
key_id
required
string format: uuid
state
required
Allowed values: pending verified active revoked
version
required
integer
>= 1
review_digest
required
string
/^sha256:[a-f0-9]{64}$/
created_at
required
string format: date-time
verified_at
string format: date-time
reviewed_at
string format: date-time
revoked_at
string format: date-time
Example
{
"mode": "test",
"state": "pending"
}

Invalid request.

Current owner/admin recipient in a signed-in session required.

Subscription unavailable in the current scope.

Subscription changed or is in an incompatible state.