Webhooks

Update webhook endpoint URL and metadata

Updates the URL and safe metadata for one webhook endpoint registration owned by the authenticated integration client. External URL: /v1/webhooks/endpoints/{id}. Current Next.js implementation path: /api/platform/v1/webhooks/endpoints/[id]. This mutating route requires Idempotency-Key, can update endpoint URL, description, subscribed event names, and active/disabled status, SSRF-validates URL changes before storage, does not issue signing secrets, and does not perform direct delivery or AWS dispatch work.

patch/webhooks/endpoints/{id}

Request

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

Path parameters

idstring uuid required

Webhook endpoint ID issued by Homejourney.

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

HTTPS webhook endpoint URL. The API normalizes safe URLs, rejects credentials, non-standard ports, and private DNS/IP targets, and never performs direct delivery during update.

descriptionstring nullable
subscribed_eventsPlatformWebhookEventType[]
status'active' | 'disabled'

Response

Webhook endpoint metadata updated.

livemodeboolean required
request_idstring required

Changes

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