Anatomy of a webhook

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

An example Rigthval webhook delivery JSON object can be found at the bottom of this page

event: The webhook event subscribed to
created: Timezone adjusted datestamp of the webhook delivery time

valuation.id: Rightval valuation ID
valaution.reference: Rightval valuation reference (displayed in agent account)
valuation.status: Current Rightval status as defined by agent
valuation.created: Datestamp of the valaution creation date
valuation.updated: Datestamp of the last update (if applicable)

valuation.property.type: Type of property: detached_house, semi-detached_house, terraced_house, flat
valuation.property.bedrooms: Number of bedrooms
valuation.property.address_1: 1st line of address
valuation.property.address_2: 2nd line of address
valuation.property.address_3: 3rd line of address
valuation.property.town: Town name
valuation.property.county: County name
valuation.property.postcode: Postcode
valuation.property.latitude: Latitude co-ordinates
valuation.property.longitude: Lontigure co-ordinates 

valuation.vendor.title: Vendor title
valuation.vendor.first_name: Vendor first name
valuation.vendor.last_name: Vendor last name
valuation.vendor.email_address: Vendor email address
valaution.vendor.telephone_home: Vendor home phone (NOT currently used)
valuation.vendor.telephone_mobile: Vendor phone number

avm.sales.min: Minimum sales valuation
avm.sales.avg: Average sales valuation
avm.sales.max: Maximum sales valuation

avm.lettings.min: Minimum monthly lettings valuation
avm.lettings.avg: Average monthly lettings valuation
avm.lettings.max: Maximum monthly lettings valuation

avm.growth: Growth index (% value increase over 5 years)

{
  "event": "valuation.created",
  "created": "2020-01-01T00:00:01+00:00",
  "valuation": {
    "id": "1111aaaa-111a-1a11-1aa1-11aa111aa111", 
    "reference": "11111111111", 
    "status": "Pending", 
    "created": "2020-01-01T00:00:01+00:00", 
    "updated": null, 
    "property": { 
      "type": "detached_house", 
      "bedrooms": "2", 
      "address_1": "1 Test Street", 
      "address_2": "", 
      "address_3": "", 
      "town": "Test Town", 
      "county": "London", 
      "postcode": "PO12 3ST", 
      "latitude": "51.000000000", 
      "longitude": "0.000000000" 
    },
    "vendor": { 
      "title": "Mr", 
      "first_name": "John", 
      "last_name": "Doe", 
      "email_address": "john@doe.com", 
      "telephone_home": "", 
      "telephone_mobile": "01234567890" 
    },
    "avm": { 
      "sales": { 
        "min": 300000, 
        "avg": 310000, 
        "max": 320000 
      }, 
      "lettings": {
        "min": 800, 
        "avg": 900, 
        "max": 1000
      }, 
      "growth": 10.0
    }
  }
}