API Reference · integration
Enrich webhook payloads via API
POST any webhook payload to Cleanlist and get an enriched version back.
Endpoint
POST https://api.cleanlist.ai/v1/enrich/webhook_payloadRequest
POST https://api.cleanlist.ai/v1/enrich/webhook_payload
Authorization: Bearer clnl_live_...
Content-Type: application/json
{
"email": "jane@acme.com"
}Response
{
"id": "ev_abc123",
"webhook_payload": {
"event_id": "<event_id>",
"input_payload": "<input_payload>",
"enriched_payload": "<enriched_payload>"
},
"meta": {
"credits_used": 11,
"providers_queried": 15
}
}Field reference
| Field | Type | Description |
|---|---|---|
| event_id | string | — |
| input_payload | string | — |
| enriched_payload | string | — |
Code samples
curl
curl -X POST https://api.cleanlist.ai/v1/enrich/webhook_payload \
-H "Authorization: Bearer $CLEANLIST_API_KEY" \
-H "Content-Type: application/json" \
-d '{"email": "jane@acme.com"}'Node.js
import Cleanlist from "cleanlist";
const client = new Cleanlist(process.env.CLEANLIST_API_KEY);
const result = await client.enrich.webhook_payload({
email: "jane@acme.com",
});
console.log(result.webhook_payload.title);Python
from cleanlist import Cleanlist
client = Cleanlist(api_key=os.environ["CLEANLIST_API_KEY"])
result = client.enrich.webhook_payload(email="jane@acme.com")
print(result["webhook_payload"]["title"])Pricing
Credit-based, no per-seat fees. This endpoint uses the standard enrichment rate:
- Email only: 1 credit per enriched webhook_payload.
- Email + phone: 11 credits per enriched webhook_payload.
- Free tier: 30 credits/mo. See all pricing.
Next steps
- Full REST reference: /product/api.
- Related glossary: data enrichment, waterfall enrichment.
- Ready to ship? Start free with 30 credits.