Webhook Subscriptions

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

Functionality

Base Employee API subscription feature (or webhooks) enables you to track updates in selected profiles by setting up a callback URL to receive change notifications:

1. Choose the profiles you want to track (using an IDs list, search filter query, 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 Base Employee API collection endpoint or Bulk Collect.

Use the following endpoints to subscribe to employee profile changes:

Request type	Endpoint
POST	/v2/subscriptions/employee_base/ids
POST	/v2/subscriptions/employee_base/filter
POST	/v2/subscriptions/employee_base/es_dsl

After creating a webhook subscription, you will begin receiving updates via webhooks the next day. Updates will be sent daily.

Or use these endpoints to subscribe to employee experience updates:

Request type	Endpoint
POST	/v2/subscriptions/experience_changes/employee_base/ids
POST	/v2/subscriptions/experience_changes/employee_base/es_dsl

After creating a webhook subscription, you will begin receiving experience updates via webhooks next Monday. Updates will be sent once a week.

Webhook triggers

Profile changes

Find information on which specific profile field changes trigger webhooks.

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

Experience changes

The subscribed experience change webhook is triggered when:

1. Employee starts a new experience position

2. Employee closes their previously open experience position.

Rate limits

The number of requests allowed is limited.

Request type	Endpoint	Rate limits
POST	/v2/subscriptions/employee_base/ids	18 requests per minute
POST	/v2/subscriptions/employee_base/filter	18 requests per minute
POST	/v2/subscriptions/employee_base/es_dsl	18 requests per minute
POST	/v2/subscriptions/experience_changes/employee_base/ids	9 requests per minute
POST	/v2/subscriptions/experience_changes/employee_base/es_dsl	9 requests per minute