Whatsapp Lead

Overview:This document contains details of the WhatsApp lead payload to be sent through to your Push API endpoint and other details that may be needed.

API Payload Details:

{
 "agent": {
     "url": "https:\/\/www.bayut.com\/brokers\/john-doe-575554.html",
     "id": "575554",
     "name": "John Doe",
     "email": "john.doe@agent.com",
     "phone_number": "971527654123"
  },
    "listing" : {
      "url" : "https:\/\/www.bayut.com\/property\/details-1234567.html",
      "reference" : "BX-S-49811"
    },
    "id" : "1291df0-afca-453e-a9b7-20cdfbb9f074",
    "message" : "Hi, I am interested in your property on Bayut. Link: https:\/\/www.bayut.com\/pm\/1234567\/f6f497f5-e9b5-4ed6-b99b-163ec71f5b65\nReference no.: BX-S-49811",
    "received_at" : "2023-09-14T12:00:15.550546Z",
    "enquirer" : {
      "name" : "Jane Doe",
      "contact_link" : "https:\/\/www.bayut.com\/whatsapp\/lead?payload=def50200902e833ba18a071f7b395ee66d14c7",
      "phone_number" : "971527654321",
      "intent" : "Buying/Renting"
    },
    "wam_id" : ""
}

Note:Please note that the agent and listing elements are optional, meaning they could be missing from the payload.The intent field within enquirer is also an optional field. If specified, its value will be one of the following:

• Buying/Renting

• Selling/Leasing

• Investing

• General inquiry

Header Details:

The header X-Bayut-Signature Is created with the below formula, through a PHP framework to help validate the authenticity of the payload -md5($secret_key . $body, false) Where, $secret_key will be provided by us once we register your API endpoint in our system and $body is the whole payload.

Needed Detail:To complete the API integration provide the specific API Endpoint URL where you wish to receive the data to support@bayut.com.