Webhook Subscriptions: Base Employee API

Overview

The topic introduces the main information for Base Employee API webhook subscriptions.

Webhook subscriptions

Try to simulate a subscription and explore subscription management options

Employee webhooks

General information on how Employee Webhooks work

Experience webhooks

General information on how Experience Webhooks work

There are two types of webhook subscriptions available:

Feature	Employee profile changes	Experience changes
Update frequency	Daily	Weekly
Webhook triggers	50+ data fields (Skills, Education, etc.)	Job starts, promotions or ends
Best for	Monitoring general profile updates	Tracking employee career changes

---

Subscription method

You can subscribe to updates using three different methods. Use the Subscription method column to find the correct endpoint for your needs.

Subscription method	Employee profile changes subscription endpoint	Experience changes subscription endpoint
By ID List	/v2/subscriptions/employee_base/ids	/v2/subscriptions/experience_changes/employee_base/ids
By Search Filter	/v2/subscriptions/employee_base/filter	–
By Elasticsearch DSL	/v2/subscriptions/employee_base/es_dsl	/v2/subscriptions/experience_changes/employee_base/es_dsl

Webhook payload

See what information is included in webhook notifications.

Employee webhooks

Each webhook notification includes the following fields:

• member_id – The ID of the employee 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.

Example payload

[
  {
    "member_id": 123,
    "status": "started_matching_query",
    "changed_fields": ["experience", "location"]
  },
  {
    "member_id": 124,
    "status": "stopped_matching_query",
    "changed_fields": ["experience"]
  },
  {
    "member_id": 125,
    "status": "changed",
    "changed_fields": ["skills", "headline", "certifications"]
  }
]

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.

Experience webhooks

Each webhook notification includes the following fields:

• member_id – The ID of the employee profile that was updated.

• status – Notifies a changed state.

Example payload

[
  {
    "member_id": 125,
    "status": "changed"
  }
]

Webhook triggers

Identify the fields that trigger Employee profile changes notifications.

Fields that trigger webhooks

Field	Change type
activity	new, deleted
awards	new, deleted
awards.date	deleted
awards.description	new, deleted
awards.issuer	new
canonical_shorthand_name	new, updated
certifications	new, deleted
certifications.certificate_url	deleted
certifications.issuer_url	new
connections_count	new, updated, deleted
country	new, updated, deleted
courses	new, deleted
deleted	updated
education	new, deleted
education.activities_and_societies	new, updated, deleted
education.date_from	new, updated, deleted
education.date_to	new, updated, deleted
education.description	new, updated, deleted
education.institution	new, updated, deleted
experience	new, deleted
experience.company_employees_count	new, updated, deleted
experience.company_id	new, updated, deleted
experience.company_industry	new, updated, deleted
experience.company_name	new, updated, deleted
experience.company_size	new, updated, deleted
experience.company_source_id	new, updated, deleted
experience.company_url	new, updated, deleted
experience.company_url_canonical_shorthand_name	new, updated, deleted
experience.company_url_shorthand_name	new, updated, deleted
experience.company_website	new, updated, deleted
experience.date_from	new, updated, deleted
experience.date_to	new, updated, deleted
experience.description	new, updated, deleted
experience.duration	new, updated, deleted
experience.is_current	new, updated, deleted
experience.location	new, updated, deleted
experience.title	new, updated, deleted
experience_count	new, updated
first_name	new, updated
follower_count	new, updated
groups	deleted
headline	new, updated, deleted
industry	deleted
interests	deleted
languages	new, deleted
last_name	new, deleted
location	new, updated, deleted
organizations	new, deleted
organizations.date_to	new, updated, deleted
organizations.description	new, updated, deleted
parent_id	updated
patents	new, deleted
patents.description	new, updated, deleted
profile_photo_url	new, updated
profile_url	updated
projects	new, deleted
projects.date_from	new
projects.date_to	deleted
projects.description	new, updated, deleted
publications	new, deleted
publications.description	new, updated, deleted
publications.publication_url	deleted
publications.publisher	new
recommendations	new, deleted
recommendations_count	new, updated, deleted
services	deleted
shorthand_name	updated
skills	deleted
summary	new, updated, deleted
test_scores	new, deleted
test_scores.date	new, updated, deleted
test_scores.description	new, updated, deleted
test_scores.score	updated
volunteering_cares	deleted
volunteering_opportunities	deleted
volunteering_positions	new, deleted
volunteering_positions.date_from	new, updated, deleted
volunteering_positions.date_to	new, updated, deleted
volunteering_positions.description	new, updated, deleted
volunteering_positions.duration	new, updated, deleted
volunteering_positions.organization_shorthand_name	new, updated, deleted
volunteering_positions.organization_url	new, updated, deleted
volunteering_supports	deleted
websites	new, deleted

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 Employee Webhook subscriptions.

Tracked fields list

Field	Field	Field
parent_id	shorthand_name	canonical_shorthand_name
connections_count	country	deleted
experience_count	first_name	follower_count
headline	industry	last_name
location	profile_photo_url	profile_url
recommendations_count	services	summary
awards	certifications	courses
education	experience	groups
interests	languages	organizations
patents	projects	publications
recommendations	activity	skills
test_scores	volunteering_cares	volunteering_opportunities
volunteering_positions	volunteering_supports	websites

Employee webhooks

Subscribe by IDs

Get notifications if one of webhook triggers has been updated:

curl -X 'POST' \
  'https://api.coresignal.com/cdapi/v2/subscriptions/employee_base/ids' \
  -H 'accept: application/json' \
  -H 'apikey: {API Key}' \
  -H 'Content-Type: multipart/form-data' \
  -d '{
  "webhook_url": "{your_webhook_url}",
  "ids": [1, 222, 3456]
}'

Subscribe by field and track skills changes:

curl -X 'POST' \
  'https://api.coresignal.com/cdapi/v2/subscriptions/employee_base/ids' \
  -H 'accept: application/json' \
  -H 'apikey: {API Key}' \
  -H 'Content-Type: multipart/form-data' \
  -d '{
  "webhook_url": "{your_webhook_url}",
  "ids": [1, 222, 3456],
  "tracked_fields": ["skills"]
}'

Subscribe by Search filters

Base Employee API Search filters with examples

Unavailable filters

created_at_gte, created_at_lte, updated_at_gte, and updated_at_lte cannot be used in subscription filter requests.

Get notifications if one of webhook triggers has been updated:

curl -X 'POST' \
  'https://api.coresignal.com/cdapi/v2/subscriptions/employee_base/filter' \
  -H 'accept: application/json' \
  -H 'apikey: {API Key}' \
  -H 'Content-Type: application/json' \
  -d '{
  "webhook_url": "{your_webhook_url}",
  "filters": {"experience_title": "Product Owner"}
}'

Subscribe by field and track location and summary changes:

curl -X 'POST' \
  'https://api.coresignal.com/cdapi/v2/subscriptions/employee_base/filter' \
  -H 'accept: application/json' \
  -H 'apikey: {API Key}' \
  -H 'Content-Type: application/json' \
  -d '{
  "webhook_url": "{your_webhook_url}",
  "filters": {"experience_title": "Product Owner"},
  "tracked_fields": ["location", "summary"]
}'

Subscribe by Elasticsearch DSL

Base Employee API Elasticsearch DSL

Unavailable filters

created and last_updated cannot be used in subscription Elasticsearch DSL queries.

Get notifications if one of webhook triggers has been updated:

curl -X 'POST' \
  'https://api.coresignal.com/cdapi/v2/subscriptions/employee_base/es_dsl' \
  -H 'accept: application/json' \
  -H 'apikey: {API Key}' \
  -H 'Content-Type: application/json' \
  -d '{
  "webhook_url": "{your_webhook_url}",
  "es_dsl_query": {
      "query": {
         "match": {
            "full_name": {
               "query": "John Smith",
               "operator": "and"
            }
         }
      }
  }'

Subscribe by field and track experience and headline changes:

curl -X 'POST' \
  'https://api.coresignal.com/cdapi/v2/subscriptions/employee_base/es_dsl' \
  -H 'accept: application/json' \
  -H 'apikey: {API Key}' \
  -H 'Content-Type: application/json' \
  -d '{
  "webhook_url": "{your_webhook_url}",
  "es_dsl_query": {
    "query": {
    }
  },
  "tracked_fields": ["experience_count", "headline"]
}'

When using the es_dsl method, include "term": {"is_parent": 1} in your query to avoid receiving notifications for duplicate records.

---

Experience webhooks

Subscribe by IDs

curl -X 'POST' \
  'https://api.coresignal.com/cdapi/v2/subscriptions/experience_changes/employee_base/ids' \
  -H 'accept: application/json' \
  -H 'apikey: {API Key}' \
  -H 'Content-Type: multipart/form-data' \
  -d '{
  "webhook_url": "{your_webhook_url}",
  "ids": [1, 222, 3456]
}'

Subscribe by Elasticsearch DSL

Base Employee API Elasticsearch DSL

Unavailable filters

created and last_updated cannot be used in subscription Elasticsearch DSL queries.

curl -X 'POST' \
  'https://api.coresignal.com/cdapi/v2/subscriptions/experience_changes/employee_base/es_dsl' \
  -H 'accept: application/json' \
  -H 'apikey: {API Key}' \
  -H 'Content-Type: application/json' \
  -d '{
  "webhook_url": "{your_webhook_url}",
  "es_dsl_query": {
    "query": {
      "match": {
        "full_name": {
          "query": "John Smith",
          "operator": "and"
        }
      }
    }
  }
}'

When using the es_dsl method, include "term": {"is_parent": 1} in your query to avoid receiving notifications for duplicate records.

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 employee ID (member_id) in the following endpoint:

Base Employee API collection endpoint

Multiple profile updates

To identify the changes in multiple profiles, you need to export the employee IDs and use them with the following Bulk Collect endpoints:

Base Employee API Bulk Collect endpoints

Follow the instructions here to successfully collect the employee data:

IDs request

GET the file name

GET the file