Anatomy of a webhook

If you need to map our webhook data to another providers requirements, take a look at this advanced support article

This is an advanced feature, if you require assistance with custom Webhooks please contact us as incorrect configuration may affect the performance of your valuation tool.

If you need to map our Webhook data to a format your third party software provider can interpret, you’ll find the structure of our webhook payload below.

Our webhooks are sent using a user defined HTTP request method (GET or POST) as JSON objects with the Content-Type: application/json header.

Webhooks are wrapped in an object that denotes the event trigger the webhook refers to and the time the webhook was triggered. A valuation object contains the webhook payload itself.

Each webhook will reference one single valuation. Batch updating records is not currently supported by our platform and as a result it is safe to assume a Webhook’s payload will not contain an array of payloads.

  'event'      => [EVENT.NAME],
  'created'    => [EVENT CREATED DATE],
  'valuation'  => {

We're currently updating our support documentation. Not all content may be currently available. For additional help please contact
Need more assistance?