Docs
API 1.39
Status
Organisation

Rotate the secret ad-hoc `webhook_url` deliveries are signed with; shown once

POST /v1/org/webhook-secret/rotate: Rotate the secret ad-hoc `webhook_url` deliveries are signed with; shown once

POST /v1/org/webhook-secret/rotate
Operation idrotateOrgWebhookSecret
Key scopeadmin: admin keys only
SectionOrganisation

#Request body

object

#Example request

curl -X POST "https://api.kaab.ist/v1/org/webhook-secret/rotate" \
  -H "Authorization: Bearer $KAAB_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

#Responses

#200

Signing secret

FieldTypeRequiredDescription
object"webhook_signing_secret"yes
secretstringyes
previous_secret_expires_atstring or null (date-time)yes
created_atstring (date-time)yes

#Errors

Every error answers with the error envelope; its code is one of the error codes.

StatusWhen
400request_invalid: request validation failed
401Missing or invalid API key
402insufficient_credits: top up to continue
403The key's scope does not cover this operation
409Conflicting state (see error.code)
422Semantically invalid request (see error.code)
429Rate limited; see Retry-After
500internal: unexpected server error

Was this page helpful?