Using webhooks with the Enrow API

This page describes how you'll be notified of Enrow's events through your webhook's endpoint.

What is a webhook ?

For those who aren't familiar with the concept, the following schema from Zoho explains it simply

Webhooks allow you to receive data without having to ask for it

Webhooks allow you to receive data without having to ask for it

A typical usage flow for the Enrow API

  1. You create a bulk search with the POST /email/find/bulk endpoint
  2. The search runs asynchronously.
  3. When it finishes, Enrow notifies you by sending an http request on your webhook.
  4. You fetch the content of the search results by using the GET /email/find/bulk endpoint

Setup a webhook

As of today, you can only edit one webhook from the webapp on the integration's page..

The format to follow is simple, provide your endpoint preceded by the http protocol of your choice, for instance: https://randomwebsite.com/api/enrow_webhook

We are planning on allowing multiple webhooks, and make their updates available through the API in the coming weeks.

Working with Enrow & webhooks

As of today, two types of event in Enrow can trigger a webhook call:

  • A single search has finished
  • A bulk search has finished

Here are the typical request payloads you can expect for these events.

1) "single_search_finished" payload

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

ℹ️ As of 22/03/2024, you now receive directly the full single search result directly in the webhook notification. This removes the need to add a following GET request to fetch it.

2) "bulk_search_finished" payload

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

These payloads allow you to then retrieve your search, using the dedicated GET endpoints.

Any questions ?

Do not hesitate to run into us using Intercom, we'll be happy to answer 😺