Subscribe to Changes: Multi-source Employee API

Overview

Subscribe to employee experience changes by:

• Submitting a list of employee IDs

• Querying employee profiles using the Elasticsearch DSL schema.

Elasticsearch DSL requests

Use endpoint /v2/subscriptions/experience_changes/employee_multi_source/es_dsl to specify a range of profiles you want to see the updates from.

Multi-source Employee API Elasticsearch DSL

Endpoint usage

1. Prepare your request using the following request by adding select filters and your webhook URL to the template:

• Change webhook_url to yours.

• Insert your Elasticsearch query in the "es_dsl_query": {} section.

• Insert your API Key token instead of {API Key}.

Request body template

curl -X 'POST' \
  'https://api.coresignal.com/cdapi/v2/subscriptions/experience_changes/employee_multi_source/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/employee_multi_source/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. Updates will be sent once a week.

You will see a subscription ID as an output for your POST request.

Save this ID for later. You can use it to find your subscription through subscription management endpoints. You can retrieve employee data using the employee IDs visible in the webhook text.

---

IDs requests

Use the endpoint /v2/subscriptions/experience_changes/employee_multi_source/ids to submit a list of IDs to subscribe to changes in a range of profiles.

Endpoint usage

1. Prepare your request using the following request by adding select filters and your webhook URL to the template:

• Insert your API Key instead of {API Key}.

• Change webhook_url to yours.

• Add the list of IDs

cURL request example

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

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. Updates will be sent once a week.

You will see a subscription ID as an output for your POST request.

Save this ID for later. You can use it to find your subscription through subscription management endpoints. You can retrieve employee data using the employee IDs visible in the webhook text.

---

Following steps

Keep in mind that to view specific changes in an employee profile, you will need to access the profile data using either the Multi-source Employee API collection endpoints or the Bulk Collect endpoints.

Single profile update

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

Webhook

{
  "member_id": 123,
  "status": "started_matching_query"
}

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_multi_source/collect/{employee_id}

Collect Multi-source Employee API data

---

Multiple profile updates

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

Webhook

{
  "member_id": 123,
  "status": "started_matching_query"
},
{
  "member_id": 124,
  "status": "stopped_matching_query"
},
{
  "member_id": 125,
  "status": "changed"
}

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

Request type	Endpoint
POST	/v2/data_requests/employee_multi_source/ids
GET	/v2/data_requests/{data_request_id}/files
GET	/v2/data_requests/{data_request_id}/files/{file_name}

Bulk Collect Multi-source Employee API data

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

IDs request

GET the file name

GET the file