Subscribe to Changes

Overview

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 DSL schema.

You can also choose to be notified of changes to any employee in our database.

Choose the subscription method that fits you best

Subscriptions using Elasticsearch DSL schema

Select employees you want to track by using Clean Employee Elasticsearch DSL schema.

Subscriptions using IDs

Select employees you want to track using their profile IDs.

Subscribe to all experience changes

Subscribe to experience changes from all available employees.

Elasticsearch DSL requests

Use endpoint /v2/subscriptions/experience_changes/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.

See Clean Employee API Elasticsearch DSL schema

Endpoint usage

1. Prepare your request using the template below:

• Insert your API Key instead of {API Key}

• Paste your webhook URL instead of {your_webhook_url}

• Paste in prepared es_dsl_query

Request body template

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

For example:

Example request

curl -X 'POST' \
  'https://api.coresignal.com/cdapi/v2/subscriptions/experience_changes/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"
            }
         }
      }
   }
}'

1. Import the cURL to any API-compatible application.

2. Send the request.

3. 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 visible in the webhook text.

---

ID list POST requests

Use the endpoint /v2/subscriptions/experience_changes/ids to order a position change subscription for specific employees using a profile ID list.

Endpoint usage

1. Prepare your request using the template below:

• Insert your API Key instead of {API Key}

• Paste your webhook URL instead of {your_webhook_url}

• Insert collected employee IDs instead of {integer_IDs}

cURL request

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

1. Import the edited cURL request to Postman or any other API-compatible application.

2. Send the request.

3. 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 visible in the webhook text.

---

Subscribe to all changes

Use the endpoint /v2/subscriptions/experience_changes/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.

Endpoint usage

1. Prepare your request using the template below:

• Insert your API Key instead of {API Key}

• Paste your webhook URL instead of {your_webhook_url}.

Template

curl -X 'POST' \
  'https://api.coresignal.com/cdapi//v2/subscriptions/experience_changes/all' \
  -H 'accept: application/json' \
  -H 'apikey: {API Key}' \
  -H 'Content-Type: application/json' \
  -d '{
  "webhook_url": "{your_webhook_url}"
}'

1. Import the edited cURL request to Postman or any other API-compatible application.

2. Send the request.

3. 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 visible in the webhook text.

Following steps

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).

Single profile update

You have received a webhook notification about an update in one profile:

Webhook

{
    "member_id": 13984834,
    "change_type": "changed"
}

To see the exact changes in the profile, you will have to use the profile ID in the following endpoint:

Request type	Endpoint
GET	/v2/employee_clean/collect/{employee_id}

Collect Clean Employee API data

---

Multiple profile updates

You have received a webhook notification about updates in several profiles:

Webhook

{
  "member_id": 123,
  "change_type": "changed"
},
{
  "member_id": 124,
  "change_type": "changed"
},
{
  "member_id": 125,
  "change_type": "changed"
}

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:

Request type	Endpoint
POST	/v2/data_requests/employee_clean/id_file
GET	/v2/data_requests/{data_request_id}/files
GET	/v2/data_requests/{data_request_id}/files/{file_name}

Follow the instructions here to successfully collect the employee data (from left to right):

IDs POST request

GET the file name

GET the file