Skip to content
KataraKatara documentation

Activate the reviewed webhook

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

Explicitly confirms the exact review digest covering destination, event types, signing key, recipient and environment. Only a verified unexpired challenge can become active.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid

Header Parameters

Section titled “Header Parameters”
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.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
version
required
integer
>= 1
review_digest
required
string
/^sha256:[a-f0-9]{64}$/
Examplegenerated
{
  "version": 1,
  "review_digest": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

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"
}

400

Section titled “400”

Invalid request.

403

Section titled “403”

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

404

Section titled “404”

Subscription unavailable in the current scope.

409

Section titled “409”

Subscription changed or is in an incompatible state.