Managed webhooks

Create a managed webhook subscription

Creates or equivalently recovers an immutable-name managed subscription with webhooks.write. The caller-supplied secret is write-only, never returned, and never persisted in idempotency evidence. Incompatible reuse of an organization/environment name returns conflict.

post/webhooks/subscriptions

Request

  • Base URL: https://platform-api.homejourney.sg/v1
  • URL: https://platform-api.homejourney.sg/v1/webhooks/subscriptions
  • Auth: HTTP bearer

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

namestring required

Immutable name unique within the organization and environment. Equivalent retries recover the existing resource; incompatible reuse returns a conflict.

urlstring uri required
descriptionstring nullable
event_typesPlatformManagedWebhookEventType[] required
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.