What are webhooks?
Webhooks allow you to send data to other systems you use that aren’t directly integrated when the job reaches a particular stage. For example, you may want to automatically send records to a management reporting system once the job is completed to update the status there. Webhooks remove the need to look up data periodically or export it and instead allows you to update other systems in real time.
What triggers are available?
We can send data to other systems when a survey reaches the following stages:
- New quote
- Unsubscribe from marketing
- Resubscribe to marketing
- Terms agreed (triggered if the customer agrees or surveyor sets the status to yes / not required)
- Payment received
- Job accepted
- Job booked
- Job rescheduled
- Draft report submitted
- Job complete
- Change in billing contact
Setting up your webhooks
Click “Create” and a new webhook row will appear.
Select the job stage at which you want to trigger the webhook
Select the job types the webhook should trigger for when a job reaches that stage
Enter the URL / webhook where you want to send the job data.
We will post the following data to the webhook for each job:
- assigned_surveyor_id
- internal_id
- internal_ref
- vat
- survey_type
- optional_services
- paid_on_date
- inspection_date
- estimated_report_date
- survey_quote
- survey_quote_without_vat
- total_quote_with_vat
- total_quote_without_vat
- total_tax
- total_paid
- total_paid_with_vat
- total_paid_without_vat
- optional_service_price_with_vat
- optional_service_price_without_vat
- customer_name
- customer_email
- customer_phone
- signed_term_logs
- signed_term_link
- tenure
- bedrooms
- property_link
- property_type
- property_address
- property_access_through
- access_name
- access_email
- access_number
- access_address
- correspondance_city
- correspondance_postal_code
- correspondance_country_code
- correspondance_state
- correspondance_address_line_one
- correspondance_address_line_two
- access_notes
- assigned_surveyor_email
- assigned_surveyor_sur_name
- assigned_surveyor_first_name
- access_company_name
- signed_terms_date
- additional_info
- property_value
- lead_source
- review_body
- review_title
- review_rating
- custom_questions
- Custom Questions Question Text: questionText
- Custom Questions Answer: answer
What happens if the webhook isn’t accepted by the other system?
If we receive an error message from the system we post the webhook to we will attempt to repost the webhook after 5 minutes, 10 minutes then 60 minutes.
The failed attempt will show under the error tab in the notifications table. You will have the option to clear the error or retry the webhook.