Webhooks

Create a sandbox webhook test event

Enqueues a sandbox-only webhook test event into the platform outbox for partner integration testing. External URL: /v1/webhooks/test-events. Current Next.js implementation path: /api/platform/v1/webhooks/test-events. This mutating route requires Idempotency-Key, always returns livemode: false, and never contains production PII, real contact details, direct delivery side effects, or AWS queue dependencies.

post/webhooks/test-events

Request

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

event_type'listing.updated' | 'viewing.requested' | 'viewing.status_changed' | 'agent.lead_created' | 'agent.lead_status_changed' | 'agency.member_changed' | 'agency.listing_distribution_changed' | 'listing_feed.status_changed' | 'site.published' | 'site.form_submitted' | 'site.scheduling_requested' | 'site.crm_delivery_failed' | 'developer.project_published' | 'developer.inventory_updated' | 'developer.price_list_published' | 'developer.showflat_requested' | 'developer.crm_delivery_failed' | 'bank.application_created' | 'bank.document_requested' | 'bank.document_uploaded' | 'bank.application_submitted' | 'bank.status_changed' | 'bank.callback_failed' | 'official_source.refresh_started' | 'official_source.refresh_completed' | 'official_source.refresh_failed' | 'official_source.schema_changed' | 'official_source.freshness_degraded' | 'service.booking_status_changed' | 'service.payment_succeeded' | 'service.payment_failed' | 'provider.payable_created' | 'provider.payout_scheduled' | 'provider.payout_paid' | 'provider.payout_failed' | 'service.refund_created' | 'service.chargeback_opened' | 'service.settlement_adjusted' | 'service.settlement_reconciled' | 'finance.application_status_changed' | 'transaction.matter_created' | 'transaction.milestone_changed' | 'transaction.document_requested' | 'transaction.document_shared' | 'conveyancing.matter_status_changed' | 'partner.certification_submitted' | 'partner.certification_approved' | 'integration.installed' | 'integration.revoked' | 'consent.granted' | 'consent.revoked' | 'data_dispute.opened' | 'data_dispute.resolved' | 'usage.quota_exceeded' | 'billing.invoice_created' | 'abuse.credential_suspended' | 'api.deprecation_notice_created'

Additive platform webhook event type. Event-specific payload DTOs are added only when a workflow route or deterministic sandbox producer can back the contract.

Response

Sandbox webhook test event accepted into the outbox.

livemodefalse required
request_idstring required

Changes

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