Webhook Subscriptions

Overview

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

Webhook subscriptions

Try to simulate a subscription and explore subscription management options

Functionality

Clean data API webhook feature enables you to track job position (experience) changes in select profiles by setting up a callback URL to receive change notifications:

1. You can choose the profiles you want to track (using an ID list or Elasticsearch DSL filter query) or track the changes of all profiles in our database

2. Provide a callback URL to receive notifications

3. Receive notifications to your URL and retrieve the data using the Clean Employee API collection endpoint or Bulk Collect.

Use the following endpoints to subscribe to job position changes:

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

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

If you choose to track all work experience changes in all available employee profiles, expect to receive ~ 500,000 or more update messages in a week.

Rate limits

The number of requests allowed is limited.

Request type	Endpoint	Rate limit
POST	/v2/subscriptions/experience_changes/ids	9 requests per minute
POST	/v2/subscriptions/experience_changes/es_dsl	9 requests per minute
POST	/v2/subscriptions/experience_changes/all	9 requests per minute