Managed webhooks

Rotate a managed webhook signing secret

Creates and atomically activates the next external secret version with webhooks.write. The caller-supplied secret is write-only and never returned; the prior version is scheduled for deletion after seven days.

post/webhooks/subscriptions/{id}/rotate-secret

Request

  • Base URL: https://platform-api.homejourney.sg/v1
  • URL: https://platform-api.homejourney.sg/v1/webhooks/subscriptions/{id}/rotate-secret
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Managed webhook subscription ID.

Headers

X-Correlation-Idstring

Optional partner-provided correlation ID echoed into request evidence.

Idempotency-Keystring required

Required for mutating platform routes. Accepted format: 8 to 128 ASCII characters matching [A-Za-z0-9._:-]+.

Request body

secretstring required

Caller-supplied signing secret. It is write-only and never appears in responses, idempotency evidence, logs, Terraform state, or OpenAPI examples.

Response

Managed webhook response with redacted secret and delivery evidence.

livemodeboolean required
request_idstring required

Changes

No recorded changes to this operation across all 1 revision of this API.