API docs by Redocly

PLATFORM RC-85 (v1.7) — Webhooks security & trust lifecycle (documentation-only) (v1.7)

Download OpenAPI specification:

Contract-only documentation for webhook secret rotation and trust gating. This file MUST NOT remove or rename any existing paths.

Stage next signing secret (rotation)

path Parameters
subscription_id
required
string
Request Body schema: application/json
required
reason
required
string <= 200 characters

Responses

Request samples

Content type
application/json
{
  • "reason": "string"
}

Response samples

Content type
application/json
{
  • "subscription_id": "string",
  • "rotation_id": "string",
  • "next_secret_preview": "string",
  • "rotation_deadline": "2019-08-24T14:15:22Z"
}

Activate staged next secret

path Parameters
subscription_id
required
string
Request Body schema: application/json
required
rotation_id
required
string

Responses

Request samples

Content type
application/json
{
  • "rotation_id": "string"
}

Response samples

Content type
application/json
{
  • "subscription_id": "string",
  • "rotation_id": "string",
  • "activated_at": "2019-08-24T14:15:22Z"
}

Revoke current secret and disable subscription

path Parameters
subscription_id
required
string
Request Body schema: application/json
required
reason
required
string <= 200 characters

Responses

Request samples

Content type
application/json
{
  • "reason": "string"
}

Response samples

Content type
application/json
{
  • "subscription_id": "string",
  • "revoked_at": "2019-08-24T14:15:22Z",
  • "status": "disabled"
}

Replay webhook deliveries (existing endpoint; RC-85 documents 409 only)

Responses

Response samples

Content type
application/json
{
  • "error_code": "subscription_disabled",
  • "message": "string",
  • "request_id": "string"
}