For the complete documentation index, see llms.txt. This page is also available as Markdown.

🆕Company Webhooks

Company Webhooks alert you when key company profile data fields change. Subscribe to receive automatic updates about the latest changes in the company records that matter to you. Find endpoints and subscription examples in the corresponding topic:

Subscription frequency

Delivery frequency depends on the specific API data source you use. Corresponding cadence:

API source
Webhooks delivery frequency

Company API

Daily

Functionality

  1. Choose the companies you want to track, using an IDs list or Elasticsearch DSL filter query.

  2. Provide a callback URL to receive notifications.

  3. Receive notifications at your URL and retrieve the data using the corresponding APIs collection or Bulk Collect endpoints.

Subscribe by field

By default, Company Webhooks trigger on any change to a tracked profile. The subscribe by field feature lets you narrow your subscription to only receive notifications when specific fields are updated.

You still define your tracked population using IDs or Elasticsearch DSL queries. The tracked_fields parameter acts as an additional filter on top of that population, specifying which fields to watch.

Example

You are tracking 500 companies by IDs but only care about key_employee_change_events changes. By adding "tracked_fields": ["key_employee_change_events"] to your subscription request, you will only receive webhooks when the key_employee_change_events field is updated – all other field changes are ignored.

Webhook triggers

The following company profile fields are tracked for changes. When any of these fields are updated, a webhook notification is sent.

Webhook payload

Each webhook notification includes the following fields:

  • company_id – The ID of the company profile that was updated.

  • status – The type of change detected (see status values below).

  • changed_fields – An array listing the specific fields that were modified on the profile.

The changed_fields array tells you exactly which parts of the profile were modified. You can use this to decide whether to retrieve the full updated profile or skip the notification based on your use case.

Status values

Status
Description

started_matching_query

Profiles that previously did not match your filters have been updated to meet your criteria. Example: the industry was updated and now matches your subscribed query.

stopped_matching_query

Profiles that once matched your filters have been updated and no longer match. Example: the industry changed from Insurance to Insurance Agencies and Brokerages.

changed

One or more tracked fields on the profile were updated. The changed_fields array in the payload shows which specific fields were modified. To retrieve the new values, use the Collect or Bulk Collect endpoints.

Last updated

Was this helpful?