Flow Documentation
Back to Flow Platform
  • Back to Flow Platform
  • Getting Started
  • Publisher Documentation
    • Introduction
    • Integrating with Flow
      • The Integration Journey
      • How to choose your integration method
        • Set-up requirements for the different integration methods
      • Integrating via Console, Link-Out and Smartfeed
        • Console
          • Console Set-Up Steps
          • Flow Console Authentication
            • Authentication method: SAML Single Sign-On
              • Final URL
        • Link-Out (self-serve)
          • Link-Out Road Map
          • Choosing between Link-Out Advanced or Basic
          • Link-Out Set-Up Steps
          • Link-Out Authentication
          • Link-Out Advanced: For clients with a feed configured
          • Link-Out Basic: Alternative to a Content Feed
        • Smartfeed
          • Smartfeed Set-up Steps
          • How the Smartfeed Engine Works
          • Campaign Triggers
      • Content Feeds
        • Content Feed Overview: What is it, why we use it, do you need it
        • Setting up a Content Feed
        • Listing API
      • Campaign Packages
        • Campaign Packages Overview: What is it, why we use it, do you need it
        • Structuring a Package
        • Understanding Campaign Objectives
      • Webhooks
        • Campaigns Webhooks
        • Leads Webhooks
      • Analytics API
        • Campaigns
        • Insights
    • Account Configuration
      • Navigating the Flow Console
      • Channel Configuration
      • Audience Tracking
      • Custom Ad Templates
      • Whitelabelling
    • Managing the Flow Console
      • Navigating the Flow Console
      • Campaigns
        • Publishing Campaigns
        • Monitoring Campaigns
        • Managing Subscriptions
      • Analytics
        • Flow Insights Dashboard: Enterprise Organisation
        • Flow Enterprise Dashboard: Filtering your Data
        • Flow Enterprise Dashboard: Insights Available
      • Content
        • Editing Content Manually
        • Add Content Manually
        • Previewing Content
        • Viewing Your Brands
      • Enquiries
      • Packages
        • How to create Campaign Packages
        • How to edit a Campaign Package
      • Brand Library
        • Editing Brand Assets
        • Ad Templates
      • General - Flow Settings
        • Reset Your Password
        • Wallet
        • Linking Your Social Media Pages
        • Adding Your Meta Pixel
        • Settings
          • General Section: Organisation, Enquiries, Colors, Address, Partners Settings
          • Users Section: Managing user profiles
          • Channel Configuration Section: Managing linked channels
          • Developer Section: Feed logs, manage Campaign Settings
    • Data Publisher Integration
      • Data Collection Methods
      • Uploading Hashed Files
  • Advertiser Documentation
    • Introduction
    • Navigating the Flow Console
    • Campaigns
      • Publishing Campaigns
      • Monitoring Campaigns
      • Managing Subscriptions
    • Analytics
      • Analytics Dashboards
    • Enquiries
    • General - Flow Settings
      • Reset Your Password
      • Wallet
      • Linking Your Social Media Pages
      • Profile - Your Own Information
  • Changelog
Powered by GitBook
On this page
  1. Publisher Documentation
  2. Integrating with Flow
  3. Webhooks

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": "+27713336789",
    "email": "steve.jobs@steve.com"
  },
  "agent": {
    "email": "vaclarke@hotmail.com",
    "firstName": "Vee",
    "lastName": "Clarke",
    "contactNumber": "+27821234567"
  },
  "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.

PreviousCampaigns WebhooksNextAnalytics API

Last updated 2 months ago