API Reference

Definitions of the email-finder payloads you will receive on your webhook endpoint

1. "single_search_finished" payload

{
  "event": "single_search_finished",
  "id": "910f3e13-b2bf-442d-ab0b-4cf44dfrij84fjrt",
  "credits": {
    "cost": 1
  },
  "result": {
    "email": "[email protected]",
    "qualification": "valid",
    "custom": "your_custom_data",
    "info": {
        "company_domain": "schrutefarms.com",
        "firstname": "Dwight",
        "lastname": "Schrute"
    }
  }
}

ℹ️ Since you receive the full search result directly in the webhook notification, this removes the need to perform a GET request to fetch it.


2. "bulk_search_finished" payload

{
  "event": "bulk_search_finished",
  "id": "910f3e13-b2bf-442d-ab0b-4cf44dfrij84fjrt",
  "credits": {
    "cost": 2284
  }
}

Once you receive a "bulk_search_finished" payload, request the /email/find/bulk endpoint with the corresponding id to get the search results.
This allows for perfect live-retrieval of your results.