Bulk search done

Sent once, when every row of a bulk search has been processed. It gives you the statistics of the file: rows processed, emails found per certainty…

Method: POST to your URL. Answer with HTTP 200.
Where to set it: on the API page (Notification when the bulk search is done), or per request with custom.webhookUrlBulkDone. See Set up webhooks.
Want the results too? Start the bulk search with "custom": { "includeResultsInWebhook": true } and every result is included in this call. For more than 1,000 rows, make sure your server accepts large requests.

Example payload

POST https://your-server.com/your-webhook
{
  "signature": "#EXAMPLE-SIGNATURE#",
  "timestamp": "2023-03-01T04:40:20Z",
  "data": {
    "file": "#FILEID#",
    "total": 2500,
    "done": 2500,
    "found": 2200,
    "aborted": 0,
    "insufficientCredits": 0,
    "certainties": {
      "verySure": 800,
      "sure": 1000,
      "probable": 400,
      "undeliverable": 0
    }
  }
}

Payload fields

signaturestring
The HMAC-SHA1 signature of the request
timestampstring
The timestamp used to compute the signature
dataobject
The file's information
Show properties (8)
- filestring
  The unique ID of the file that was being processed.
- totalnumber
  Total number of valid rows in your file
- donenumber
  Number of rows that were already searched in your file
- foundnumber
  Number of found emails in your file
- abortednumber
  Number of aborted rows in your file
- insufficientCreditsnumber
  Number of aborted rows caused by a lack of credits in your file
- certaintiesobject
  Certainties' statistics for your bulk search
  Show properties (4)
  - verySurenumber
    Count of currently processed rows classified as 'very_sure'
  - surenumber
    Count of currently processed rows classified as 'sure'
  - probablenumber
    Count of currently processed rows classified as 'probable'
  - undeliverablenumber
    Count of currently processed rows classified as 'undeliverable' (only used for email verification)
- resultsarray of objects
  Results of the bulk if you have specified the 'includeResultsInWebhook' option in the custom object when launching your bulk
  Show item properties (9)
  - namestring
    Name of the search ('__icypeas__individual' if it is a single search).
  - userstring
    User ID of the user linked to this search.
  - filestring
    File id when it is a bulk search
  - resultsobject
    Object containing the results of your search.
    Show properties (6)
    firstnamestring
    First name found during the search, if any.
    lastnamestring
    Last name found during the search, if any.
    fullnamestring
    Concatenation of the user's first and last names, if any.
    emailsarray of objects
    Array of the found email addresses.
    Show item properties (4)
    emailstring
    Email address found during the search.
    certaintyenum
    How sure Icypeas is that this address exists: ultra_sure, very_sure, probable, undeliverable or not_found. See the Email certainty page.
    mxProviderenum
    Who hosts the mailbox (google, microsoft, ovh…). See the MX providers page.
    mxRecordsarray
    Array of MX records. Those are strings
    phonesarray
    Currently empty.
    saasServicesarray
    Currently empty.
  - ordernumber
    If in bulk search mode, it is the row of the file it was in.
  - statusstring
    Status of this search.
  - systemobject
    Information concerning the search.
    Show properties (2)
    createdAtstring
    ISO String Date representing the creation date of the search.
    modifiedAtstring
    ISO String Date representing the last modification date of the search.
  - userDataobject
    Custom data that were passed when running either the bulk search or the single search
    Show properties (2)
    webhookUrlstring
    Custom webhook URL that will be called for this search (the field is empty if no URL has been passed when running the single/bulk search)
    externalIdstring
    Custom id provided by the user (the field is empty if not custom id was passed when running the single/bulk search)
  - _idstring
    ID of the search.