Webhooks: Company API
Overview
The topic introduces the main information for Company API webhook subscriptions.
There are two types of webhook subscriptions available:
Update frequency
Daily
Webhook triggers
170+ data fields
Best for
Monitoring general profile updates
Subscription method
You can subscribe to updates in two ways. Use the Subscription method column to find the correct endpoint for your needs.
By ID List
/v2/subscriptions/company_multi_source/ids
By Elasticsearch DSL
/v2/subscriptions/company_multi_source/es_dsl
Webhook payload
See what information is included in webhook notifications.
Webhook triggers
Identify the company data fields that trigger company profile change notifications.
Trackable fields
The following fields can be used with the tracked_fields parameter (subscribe by field) and will appear in the changed_fields array in webhook payloads. This list is used to track changes via Company Webhook subscriptions.
Company webhooks
Subscribe using IDs
Get notifications if one of webhook triggers has been updated:
Subscribe by fields and track company_name and key_employee_change_events changes:
Subscribe using Elasticsearch DSL
Get notifications if one of webhook triggers has been updated:
Subscribe by fields and track company_name and competitors changes:
Retrieving updated profile data
After receiving a webhook notification, use the changed_fields array to determine if you need to fetch the updated profile data.
Single profile update
To see the exact changes in one profile, you will have to use the company ID (company_id) in the following endpoint:
Multiple profile updates
To identify the changes in multiple profiles, you need to export the company IDs and use them with the following Bulk Collect endpoints:
Follow the instructions here to successfully collect the company data:
Last updated
Was this helpful?