Leads Webhooks

Lead webhooks are used to send lead inquiry data to your CRM whenever a prospective buyer expresses interest in a product. This webhook is triggered when a user submits an inquiry via the platform.

Webhook Payload Example

Create an endpoint URL on the client’s server where Flow will send webhook notifications. This URL should be publicly accessible without authentication other than IP whitelisting, and should be configured to receive a JSON payload. Flow will send a POST request with the payload in JSON format in the body. When a lead is captured, the webhook sends the following JSON payload to the configured endpoint:

{
  "message": "I'm interested in this apartment, please contact me",
  "tenant": {
    "firstName": "Steve",
    "lastName": "Jobs",
    "contactNumber": "[phone]",
    "email": "[email protected]"
  },
  "agent": {
    "email": "[email protected]",
    "firstName": "Vee",
    "lastName": "Clarke",
    "contactNumber": "[phone]"
  },
  "enquiredDate": "2025-03-05T09:42:59.735Z",
  "enquiry": {
    "additionalInfo": {
      "price": "3000000",
      "suburb": "Illovo",
      "user_message": "I'm interested in this apartment, please contact me"
    }
  },
  "property": {
    "propertyId": "67a9db42292de6eb21418eb5",
    "propertyName": "2 bedroom Gem",
    "propertyType": "apartment",
    "rentalAmount": 3000000,
    "bedrooms": 2,
    "bathrooms": 2,
    "parkings": "1",
    "displayPrice": "3000000",
    "address": {
      "city": "Sandton",
      "country": "South Africa",
      "line1": "3 Otto Street",
      "postCode": "2196",
      "province": "Gauteng",
      "suburb": "Illovo",
      "countryCode": "ZA",
      "locality": ""
    },
    "listingType": "For sale",
    "extpropertyId": "test123"
  }
}

Webhook Endpoint & Configuration

• The webhook is triggered when a lead submits an inquiry.

• The data is sent via an HTTP POST request to the configured CRM endpoint.

• Ensure your endpoint can handle JSON payloads and process lead information accordingly.