Importing Leads⚓︎

The Lead Import service is designed for external portals looking to send new leads or update existing ones in Maxwork. This process handles leads received via API, transferring the data to a Service Bus (SB). From there, the Importing Job processes the leads, ensuring essential data is updated efficiently and accurately.

Importing Workflow⚓︎

Receiving Leads From Maxwork⚓︎

Before importing leads into Maxwork, you must first start receiving them through our webhook. To receive leads from Maxwork, you need to contact our team to set up the export process tailored to your business.

Important Information⚓︎

Before we can start exporting, we need the following information:

1. Staging API Endpoint - For Testing Purposes,
2. API Authentication Methods & Credentials,
3. API Documentation (if applicable).

Exporting Schema⚓︎

Our leads when exporting follows the following schema:

// Data Schema
{
  "external_id": "98765", // Maxwork ID
  "full_name": "John Doe",
  "cell_phone": "+1234567890",
  "reference_no": "Listing-12345",
  "contacted_at": "2025-04-03 14:30:00",
  "archived_at": "2025-04-01 10:00:00",
  "message": "Looking for a 3-bedroom apartment",
  "price_min": 100000,
  "price_max": 300000,
  "room_min": 2,
  "room_max": 4,
  "area_min": 50,
  "area_max": 120,
  "latitude": 40.7128,
  "longitude": -74.0060,
  "note": "Referred by agent XYZ",
  "agent": {
    "external_id": "112233",
    "office_id": "445566"
  },
  "group": "apartment",
  "category": "residential",
  "tenure": "lease",
  "type": "buyer",
  "attributes": [
    "parking_space",
    "lift"
  ]
}