Subscribe to Changes
Set up webhooks to track employee job position changes. Select the employees of interest by:
- Submitting a list of employee IDs
- Selecting profiles using Elasticsearch schema (ES DSL).
You can also choose to be notified of changes of any employee in our database.
Select employees you want to track by using Clean Employees ES DSL schema.
Subscriptions using IDs
Select employees you want to track using their profile IDs.
Subscribe to experience changes from all available employees.
Response Codes
See the list of possible error codes.
Use endpoint /v1/subscriptions/professional_network/member_experience/es_dsl to specify a range of profiles from which you want to see the updates.
Keep in mind that last_updated filter is not available for subscription requests.
Elasticsearch DSL
- Prepare your request using the template below: 1. Insert your JWT token instead of {JWT} 2. Paste your webhook URL instead of {your_webhook_url} 3. Paste in prepared es_dsl_query.
- Import the cURL to any API-compatible application.
- Send the request.
- You will start getting updates on select profiles after two days.
You will see a subscription ID as an output for your POST request. However, you can ignore this ID since the webhook updates will provide the necessary data. You can retrieve employee data using the employee IDs (member IDs) visible in the webhook text.
Use the endpoint /v1/subscriptions/professional_network/member_experience/ids to order a position change subscription of specific employees using a profile ID list.
- Prepare your request using the template below: 1. Insert your JWT token instead of {JWT} 2. Paste your webhook URL instead of {your_webhook_url} 3. Insert collected employee (member) IDs instead of {integer_IDs}.
- Import the edited cURL request to Postman or any other API-compatible application.
- Send the request.
- You will start getting updates on select profiles after two days.
You will see a subscription ID as an output for your POST request. However, you can ignore this ID since the webhook updates will provide the necessary data. You can retrieve employee data using the employee IDs (member IDs) visible in the webhook text.
Use the endpoint /v1/subscriptions/professional_network/member_experience/all to order subscriptions and get notified of changes from all employees available in our database.
If you choose to track all available employees' job position changes, expect to receive ~ 500,000 or more update messages in a week.
- Prepare your request using the template below: 1. Insert your JWT token instead of {JWT} 2. Paste your webhook URL instead of {your_webhook_url}.
- Import the edited cURL request to Postman or any other API-compatible application.
- Send the request.
- You will start getting updates on select profiles after two days.
You will see a subscription ID as an output for your POST request. However, you can ignore this ID since the webhook updates will provide the necessary data. You can retrieve employee data using the employee IDs (member IDs) visible in the webhook text.
Remember that to view specific changes in an employee's profile, you will need to access the profile data using the Clean Employee API collection endpoints (collect or Bulk Collect).
You have received a webhook notification about an update in one profile:
To see the exact changes in the profile, you will have to use the profile ID in the following endpoint:
Function | Endpoint |
|---|---|
GET | /v1/professional_network/clean_member/collect/{member_id} |
You have received a webhook notification about updates in several profiles:
To identify the changes in these profiles, you need to export the employee IDs in a CSV or TXT file and use them with the following Bulk Collect endpoints:
Function | Endpoint |
|---|---|
POST | /v1/professional_network/clean_member/bulk_collect/id_file |
GET | /v1/bulk_collect/{data_request_id}/files |
GET | /v1/bulk_collect/{data_request_id}/files/{file_name} |
Follow the instructions here to successfully collect the employee data (from left to right):