Webhook Basics

CleverROI provides a simple webhook endpoint that accepts lead data, scores it, and returns the result. You can call it from any application that can send HTTP requests.

Endpoint URL

https://yourdomain.com/api/webhook.php

Replace yourdomain.com with your actual domain.

Authentication

You must include your API key in the request header. Find your API key in the CleverROI dashboard under Profile or Webhook Info.

X-API-KEY: your_api_key_here

Request Format

Send a POST request with a JSON body containing at least one of email or phone. All fields are optional but recommended for accurate scoring. Custom fields can be included in a nested object.

{
  "name": "Akash Singh",
  "email": "akash.digitalteam@gmail.com",
  "phone": "+918864946549",
  "budget": "10 Lakh",
  "message": "Hi, I saw your solution online. We might explore this for our clients. Please share full details and pricing.",
  "source": "facebook",
  "custom_fields": {
    "Your role": "Consultant",
    "When do you want to start?": "Not decided",
    "Are you decision maker?": "Yes",
    "Company size": "5-10",
    "Primary goal": "Exploring options"
  }
}

Response

The API returns a JSON object with the scoring result:

{
  "success": true,
  "version": "2.0.0",
  "lead_id": "lead_123abc",
  "data": {
    "score": 90,
    "grade": "Hot",
    "priority_action": "Immediate call (within 1 hour)",
    "closing_probability": "High (70-90%)",
    "reasons": [
      "Free email domain",
      "Valid phone length",
      "Valid international phone number",
      "Enterprise-level budget",
      "Detailed inquiry",
      "Source weight applied",
      "Structured signal: Numeric qualification detected",
      "AI intent: Moderate intent (confidence: medium)",
      "Risk control: Reliability-adjusted upside applied (1)",
      "Risk control: High-score dampening applied"
    ],
    "ai": {
      "score": 10,
      "max_score": 20,
      "display": "10/20",
      "impact": "Medium",
      "confidence": "medium",
      "influence_applied": 7
    },
    "contact_grade": "B"
  }
}

If the request is invalid or the plan limit is reached, you'll receive an error response.

Example cURL

curl -X POST https://yourdomain.com/api/webhook.php \
  -H "X-API-KEY: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Akash Singh",
    "email": "akash.digitalteam@gmail.com",
    "phone": "+918864946549",
    "budget": "10 Lakh",
    "message": "Hi, I saw your solution online. We might explore this for our clients. Please share full details and pricing.",
    "source": "facebook",
    "custom_fields": {
      "Your role": "Consultant",
      "When do you want to start?": "Not decided",
      "Are you decision maker?": "Yes",
      "Company size": "5-10",
      "Primary goal": "Exploring options"
    }
  }'