← Home Push — WhatsApp Story Lead

Whatsapp Story Lead

Overview:This document contains details of the payload to be sent through to your Push API endpoint for Whatsapp leads originating from TruBroker stories that are associated to a property, project or Loc3/purpose.

API Payload Details:

{
  "id" : "1291df0-afca-453e-a9b7-20cdfbb9f074",
  "agent": {
    "id": "575554",
    "name": "John Doe",
    "email": "john.doe@explorer.com",
    "url": "https:\/\/www.bayut.com\/brokers\/john-doe-575554.html",

  },
  "story": {
    "id": "12345",
    "type": "property", (possible values "property", "project", "loc_purpose")
    "listing_url": "https:\/\/www.bayut.com\/property\/details-1234567.html",
    "listing_title": "Sharjah Sustainable City",
    "project_title": "Arista One",
    "listing_reference": "BX-S-49811",
    "project_url": "https:\/\/www.bayut.com\/for-sale\/property\/dubai\/al-satwa\/jumeirah-garden-city\/arista-one\/"
    "loc3_name": "Business Bay",
    "purpose": "sale"   (possible values: "sale", "rent")
  },
  "message" : "Hi, I am interested in the property below, which is featured in your TruBroker™ story. 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://ovation-live.bayut.com/ingest/whatsAppContactStatus/?external_id=10994584&type=property&source=imported&sender=971566424239&destination=971566424239&message_type=contact_lead&lc=en_US",
      "phone_number" : "971527654321"
  },
  "wam_id" : ""
}

Note:The following fields in the payload are optional, depending on the story type

  • story.listing_url

  • story.listing_title

  • story.listing_reference

  • story.project_url

  • story.project_title

  • story.purpose

If story.type is property the following fields will be missing:

  • story.project_url

  • story.project_title

If story.type is ‘project’, the following fields will be missing:

  • story.listing_reference

  • story.purpose

If story.type is ‘loc_purpose’, the following fields will be missing:

  • story.listing_url

  • story.listing_title

  • story.listing_reference

  • story.project_url

  • story.project_title

Please refer to theSample payloadssection for examples of payloads for each story type.

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.

Sample payloads:

  1. Story lead associated with property

{
  "id" : "1291df0-afca-453e-a9b7-20cdfbb9f074",
  "agent": {
    "id": "575554",
    "name": "John Doe",
    "email": "john.doe@explorer.com",
    "url": "https:\/\/www.bayut.com\/brokers\/john-doe-575554.html",
  },
  "story": {
    "id": "12345",
    "type": "property",
    "listing_url": "https:\/\/www.bayut.com\/property\/details-1234567.html",
    "listing_title": "Renting 3 Bedroom apartment in Business Bay",
    "listing_reference": "BX-S-49811",
    "loc3_name": "Business Bay",
    "purpose": "rent",
  },
  "message" : "Hi, I am interested in the property below, which is featured in your TruBroker™ story. Link: https:\/\/www.bayut.com\/pm\/1234567\/f6f497f5-e9b5-4ed6-b99b-163ec71f5b65\nReference no.: BX-S-49811",
  "received_at" : "2025-06-14T12:00:15.550546Z",
  "enquirer" : {
      "name" : "Jane Doe",
      "contact_link" : "https://ovation-live.bayut.com/ingest/whatsAppContactStatus/?external_id=1234567&type=property&source=imported&sender=971566424239&destination=971566424239&message_type=contact_lead&lc=en_US",
      "phone_number" : "971527654321"
  },
  "wam_id" : "18387603-6128-4e9c-93e5-1d7ea1b3969b"
}

  1. Story lead associated with project:

{
  "id" : "1291df0-afca-453e-a9b7-20cdfbb9f074",
  "agent": {
    "id": "575554",
    "name": "John Doe",
    "email": "john.doe@explorer.com",
    "url": "https:\/\/www.bayut.com\/brokers\/john-doe-575554.html",
  },
  "story": {
    "id": "12345",
    "type": "project",
    "project_url": "https:\/\/www.bayut.com\/for-sale\/property\/dubai\/al-satwa\/jumeirah-garden-city\/arista-one\/",
    "project_title": "Arista One",
    "loc3_name": "Al Satwa",
  },
  "message" : "Hi! I am interested in the project featured below in your TruBroker™ story. Project name: Arista One Agent Profile Link: https:\/\/www.bayut.com\/brokers\/john-doe-575554\/f6f497f5-e9b5-4ed6-b99b-163ec71f5b65.html\n*Kindly do not edit this message to ensure your enquiry is received.",
  "received_at" : "2025-06-14T12:00:15.550546Z",
  "enquirer" : {
      "name" : "Jane Doe",
      "contact_link" : "https://ovation-live.bayut.com/ingest/whatsAppContactStatus/?external_id=1234567&type=property&source=imported&sender=971566424239&destination=971566424239&message_type=contact_lead&lc=en_US",
      "phone_number" : "971527654321"
  },
  "wam_id" : "18387603-6128-4e9c-93e5-1d7ea1b3969b"
}

  1. Story lead associated with location and purpose

{
  "id" : "1291df0-afca-453e-a9b7-20cdfbb9f074",
  "agent": {
    "id": "575554",
    "name": "John Doe",
    "email": "john.doe@explorer.com",
    "url": "https:\/\/www.bayut.com\/brokers\/john-doe-575554.html",
  },
  "story": {
    "id": "12345",
    "type": "loc_purpose",
    "loc3_name": "Business Bay",
    "purpose" "sale"
  },
  "message" : "Hi! I am interested in knowing more about properties for sale in Al Satwa as featured in your TruBroker™ story. Link: https:\/\/www.bayut.com\/brokers\/john-doe-575554\/f6f497f5-e9b5-4ed6-b99b-163ec71f5b65.html \n *Kindly do not edit this message to ensure your enquiry is received.",
  "received_at" : "2025-06-14T12:00:15.550546Z",
  "enquirer" : {
      "name" : "Jane Doe",
      "contact_link" : "https://ovation-live.bayut.com/ingest/whatsAppContactStatus/?external_id=1234567&type=property&source=imported&sender=971566424239&destination=971566424239&message_type=contact_lead&lc=en_US",
      "phone_number" : "971527654321"
  },
  "wam_id" : "18387603-6128-4e9c-93e5-1d7ea1b3969b"
}
Code Examples
{
  "id" : "1291df0-afca-453e-a9b7-20cdfbb9f074",
  "agent": {
    "id": "575554",
    "name": "John Doe",
    "email": "john.doe@explorer.com",
    "url": "https:\/\/www.bayut.com\/brokers\/john-doe-575554.html",

  },
  "story": {
    "id": "12345",
    "type": "property", (possible values "property", "project", "loc_purpose")
    "listing_url": "https:\/\/www.bayut.com\/property\/details-1234567.html",
    "listing_title": "Sharjah Sustainable City",
    "project_title": "Arista One",
    "listing_reference": "BX-S-49811",
    "project_url": "https:\/\/www.bayut.com\/for-sale\/property\/dubai\/al-satwa\/jumeirah-garden-city\/arista-one\/"
    "loc3_name": "Business Bay",
    "purpose": "sale"   (possible values: "sale", "rent")
  },
  "message" : "Hi, I am interested in the property below, which is featured in your TruBroker™ story. 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://ovation-live.bayut.com/ingest/whatsAppContactStatus/?external_id=10994584&type=property&source=imported&sender=971566424239&destination=971566424239&message_type=contact_lead&lc=en_US",
      "phone_number" : "971527654321"
  },
  "wam_id" : ""
}
{
  "id" : "1291df0-afca-453e-a9b7-20cdfbb9f074",
  "agent": {
    "id": "575554",
    "name": "John Doe",
    "email": "john.doe@explorer.com",
    "url": "https:\/\/www.bayut.com\/brokers\/john-doe-575554.html",
  },
  "story": {
    "id": "12345",
    "type": "property",
    "listing_url": "https:\/\/www.bayut.com\/property\/details-1234567.html",
    "listing_title": "Renting 3 Bedroom apartment in Business Bay",
    "listing_reference": "BX-S-49811",
    "loc3_name": "Business Bay",
    "purpose": "rent",
  },
  "message" : "Hi, I am interested in the property below, which is featured in your TruBroker™ story. Link: https:\/\/www.bayut.com\/pm\/1234567\/f6f497f5-e9b5-4ed6-b99b-163ec71f5b65\nReference no.: BX-S-49811",
  "received_at" : "2025-06-14T12:00:15.550546Z",
  "enquirer" : {
      "name" : "Jane Doe",
      "contact_link" : "https://ovation-live.bayut.com/ingest/whatsAppContactStatus/?external_id=1234567&type=property&source=imported&sender=971566424239&destination=971566424239&message_type=contact_lead&lc=en_US",
      "phone_number" : "971527654321"
  },
  "wam_id" : "18387603-6128-4e9c-93e5-1d7ea1b3969b"
}
{
  "id" : "1291df0-afca-453e-a9b7-20cdfbb9f074",
  "agent": {
    "id": "575554",
    "name": "John Doe",
    "email": "john.doe@explorer.com",
    "url": "https:\/\/www.bayut.com\/brokers\/john-doe-575554.html",
  },
  "story": {
    "id": "12345",
    "type": "project",
    "project_url": "https:\/\/www.bayut.com\/for-sale\/property\/dubai\/al-satwa\/jumeirah-garden-city\/arista-one\/",
    "project_title": "Arista One",
    "loc3_name": "Al Satwa",
  },
  "message" : "Hi! I am interested in the project featured below in your TruBroker™ story. Project name: Arista One Agent Profile Link: https:\/\/www.bayut.com\/brokers\/john-doe-575554\/f6f497f5-e9b5-4ed6-b99b-163ec71f5b65.html\n*Kindly do not edit this message to ensure your enquiry is received.",
  "received_at" : "2025-06-14T12:00:15.550546Z",
  "enquirer" : {
      "name" : "Jane Doe",
      "contact_link" : "https://ovation-live.bayut.com/ingest/whatsAppContactStatus/?external_id=1234567&type=property&source=imported&sender=971566424239&destination=971566424239&message_type=contact_lead&lc=en_US",
      "phone_number" : "971527654321"
  },
  "wam_id" : "18387603-6128-4e9c-93e5-1d7ea1b3969b"
}
{
  "id" : "1291df0-afca-453e-a9b7-20cdfbb9f074",
  "agent": {
    "id": "575554",
    "name": "John Doe",
    "email": "john.doe@explorer.com",
    "url": "https:\/\/www.bayut.com\/brokers\/john-doe-575554.html",
  },
  "story": {
    "id": "12345",
    "type": "loc_purpose",
    "loc3_name": "Business Bay",
    "purpose" "sale"
  },
  "message" : "Hi! I am interested in knowing more about properties for sale in Al Satwa as featured in your TruBroker™ story. Link: https:\/\/www.bayut.com\/brokers\/john-doe-575554\/f6f497f5-e9b5-4ed6-b99b-163ec71f5b65.html \n *Kindly do not edit this message to ensure your enquiry is received.",
  "received_at" : "2025-06-14T12:00:15.550546Z",
  "enquirer" : {
      "name" : "Jane Doe",
      "contact_link" : "https://ovation-live.bayut.com/ingest/whatsAppContactStatus/?external_id=1234567&type=property&source=imported&sender=971566424239&destination=971566424239&message_type=contact_lead&lc=en_US",
      "phone_number" : "971527654321"
  },
  "wam_id" : "18387603-6128-4e9c-93e5-1d7ea1b3969b"
}