Lead Webhook

webhook

leads

This webhook delivers any associated job lead to your defined URL endpoint.Doing so allows for you to integrate leads from Checkatrade directly intoyour CRM.

Payload

jobId

string

required

The ID of the Job Lead

category

string

required

The category the Job belongs too

title

string

required

The title of the job (typically category + postcode)

jobDescription

string

required

More details about the Job and the requirements

customerName

string

required

The name of the Customer associated to the Job

customerEmail

string

required

The email of the Customer associated to the Job

customerPhone

string

required

The phone number of the Customer associated to the Job

dateCreated

date-time

required

The date the job was created in ISO 8061 as mentioned on RFC3339

preferredStart

object | null

The urgency of the Job from the Customer

source

string

enum

required

The source/type of the job request

Allowed:

additionalInformation

array of objects

Defaults to []

Any extras that may relate to the Job such as questions and answers

additionalInformation

postcode

string

required

The postcode of the Customer associated to the Job

leadEnrichment

object

Additional structured information about the job lead with more detailed questions and answers

media

array of strings

URLs to media files (such as photos) associated with the job

media

Response

201

Return a 201 status to indicate that the data was received successfully

Loading…