Scribd
Upload
40 views3 pages

API Documentation - Lead Creation Webhook

The document outlines the API for lead creation via a webhook, detailing the required endpoint, authentication headers, and request body structure. It specifies mandatory headers such as api-key and app-id, and provides a JSON payload example for submitting lead information. Additionally, it describes the expected success and error responses for the API calls.

Uploaded by

tech
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
40 views3 pages

API Documentation - Lead Creation Webhook

The document outlines the API for lead creation via a webhook, detailing the required endpoint, authentication headers, and request body structure. It specifies mandatory headers such as api-key and app-id, and provides a JSON payload example for submitting lead information. Additionally, it describes the expected success and error responses for the API calls.

Uploaded by

tech
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd

API Documentation: Lead Creation

Webhook

📍 Endpoint
POST [Link]

🔐 Authentication
This API requires two headers:

●​ api-key: API Key provided by the platform​

●​ app-id: Application ID associated with your account​

✅ Both headers are mandatory.

📥 Request Headers
Header Value Required

Content-Type application/json ✅
api-key Your API key (e.g., ✅
fe491fdb-...)

app-id Your App ID (e.g., ✅


92380766-...)
📨 Request Body
JSON payload structure:

{
"logged_in_company_id": "368",
"data": [
{
"Customer Name": "test webhook 3",
"Customer Number": "8220395590",
"Email": "[Link]@[Link]",
"Address": "45 MG Road, Delhi, 110001",
"Pincode": "110001",
"Interested SKUs": "test product",
"Lead Creation Date": "10-Jul-2025",
"Campaign Name": "Whatsapp",
"Remarks": "cold lead",
"Lead Source": "webhook",
"details": {
"device": "Mobile",
"browser": "Chrome",
"os": "Android",
"source": "Landing Page",
"utm_source": "GoogleAds",
"utm_medium": "CPC",
"utm_campaign": "SummerLaunch",
"referrer": "[Link]
"ip": "[Link]",
"timezone": "Asia/Kolkata",
"firstTouch": "2025-07-30T[Link]Z",
"lastTouch": "2025-07-31T[Link]Z",
"pageHistory": ["/home", "/products/smart-lock",
"/book-demo"]
}
}
]
}

✅ Success Response
HTTP 200 OK

[
{
"message": "Success"
}
]

⚠️ Error Response (Validation Issues)


HTTP 400 OK (with warning message)

[
{
"message": [
{
"message": "Some columns are missing or extra in these
[Link] with extra fields are sanitised but other are removed."
}
]
}
]

You might also like