Webhooks

Create webhook endpoint

Creates one webhook endpoint registration for the authenticated integration client. External URL: /v1/webhooks/endpoints. Current Next.js implementation path: /api/platform/v1/webhooks/endpoints. This mutating route requires Idempotency-Key, SSRF-validates and normalizes the endpoint URL before storage, returns the raw whsec_... signing secret only in the first successful create response, persists only a redacted idempotency replay body with signing_secret: null, and does not perform direct delivery or AWS dispatch work.

post/webhooks/endpoints

Request

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

urlstring uri required

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 create.

descriptionstring
subscribed_eventsPlatformWebhookEventType[] required

Response

Webhook endpoint registered. The signing secret is shown once; idempotency replays return a redacted secret field.

signing_secretstring nullable required

Raw whsec value shown only in the first successful create response. Idempotency replays return null so raw signing secrets are not persisted.

signing_secret_revealedboolean required
livemodeboolean required
request_idstring required

Changes

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