API Reference

Manage webhook endpoints

Create, test, inspect, and purge webhook endpoints in the dashboard.

Create an endpoint

  1. Open Developer → Webhooks in the portal.
  2. Register an HTTPS URL (normalized; active URL must be unique).
  3. Copy the one-time signing secret whsec_....

Subscribe a template

Live deliveries require the inquiry template revision to list the event in definition.webhooks.subscribe. Publish the revision after updating subscriptions.

Test an endpoint

Portal test deliveries skip template subscription checks and set data._test = true. Use them to validate connectivity and signature verification before go-live. See signature verification.

Rotate or remove

Purge an endpoint from the portal when retiring a URL. Create a new endpoint to rotate the signing secret (new secret is generated on create).