Managed webhooks

Update a managed webhook subscription

Updates URL, event selection, description, or active/paused state with webhooks.write. Name, organization, client, environment, and secret identity remain immutable.

patch/webhooks/subscriptions/{id}

Request

  • Base URL: https://platform-api.homejourney.sg/v1
  • URL: https://platform-api.homejourney.sg/v1/webhooks/subscriptions/{id}
  • 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

urlstring uri
descriptionstring nullable
event_typesPlatformManagedWebhookEventType[]
status'active' | 'paused'

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.