Subscribe to Changes

overview subscribe to employee profile changes by submitting a list of employee ids querying employee profiles using search filters querying employee profiles using the es dsl schema choose the subscription method that fits you best subscribe to changes docid\ cp99d8xsk0zim4xwtfwyi use elasticsearch to specify the changes you want to be notified about subscribe to changes docid\ cp99d8xsk0zim4xwtfwyi use search filters to specify the changes you want to be notified about subscribe to changes docid\ cp99d8xsk0zim4xwtfwyi submit profile ids to be notified of changes in that specific range post requests using elasticsearch schema use endpoint /v2/subscriptions/employee base/es dsl to specify a range of profiles you want to see the updates from t he following filters are not available in the subscription es dsl requests created last updated elasticsearch dsl docid\ yfre8nrflbrr2wcsgsln endpoint usage prepare your request using the following request by adding select filters and your webhook url to the template request body template curl x 'post' \\ 'https //api coresignal com/cdapi/v2/subscriptions/employee base/es dsl' \\ h 'accept application/json' \\ h 'apikey {api key}' \\ h 'content type application/json' \\ d '{ "webhook url" "{your webhook url}", "es dsl query" {} }' request example example request curl x 'post' \\ 'https //api coresignal com/cdapi/v2/subscriptions/employee base/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 doe", "operator" "and" } } } } }' insert your api key token instead of {api key} insert your elasticsearch query in the "es dsl query" {} section change webhook url to yours import the curl to any api compatible application send the request you will start receiving updates via webhooks the next day updates will be sent daily 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 post requests using search filters use endpoint /v2/subscriptions/employee base/filter to specify a range of profiles you want to see the updates from t he following filters are not available in the subscription search filter requests created at gte and created at lte updated at gte and last updated at lte search filters docid\ tyh6bkmm2b7p5 y2r29xh endpoint usage prepare your request using the following request by adding select filters and your webhook url to the template request body template curl x 'post' \\ 'https //api coresignal com/cdapi/v2/subscriptions/employee base/filter' \\ h 'accept application/json' \\ h 'apikey {api key}' \\ h 'content type application/json' \\ d '{ "webhook url" "{your webhook url}", "filters" {} }' request example example request curl x 'post' \\ 'https //api coresignal com/cdapi/v2/subscriptions/employee base/filter' \\ h 'accept application/json' \\ h 'apikey {api key}' \\ h 'content type application/json' \\ d '{ "webhook url" "{your webhook url}", "filters" {"experience title" "product owner"} }' insert your api key instead of {api key} add the selected filters in the "filters" {} section change webhook url to yours import the prepared curl request to any api compatible application send the request you will start receiving updates via webhooks the next day updates will be sent daily 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 post requests using ids use the endpoint /v2/subscriptions/employee base/ids to submit a list of ids in csv format to subscribe to changes in a range of profiles check the example for the id list formatting https //archbee doc uploads s3 amazonaws com/inaodshbfav9t72jx5jdm/cjdkl0wlyb3kqdqsix8fj idlistexample csv endpoint usage prepare the ids file in a csv format make sure the list only contains numeric ids avoid any additional headings in the file the request will fail if non numeric data is present in the file enter your api key instead of {api key} and your webhook url in the curl request template curl request curl x 'post' \\ 'https //api coresignal com/cdapi/v2/subscriptions/employee base/ids' \\ h 'accept application/json' \\ h 'apikey {api key}' \\ h 'content type multipart/form data' \\ f 'upload file=@id list example csv;type=text/csv' \\ f 'webhook url={your webhook url}' import the edited curl request to postman or any other api compatible application further instructions are for the post requests using postman click body upload the ids file by clicking the select files button in the value column send the request you will start receiving updates via webhooks the next day updates will be sent daily 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 base 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 base/collect/{employee id} collect docid\ jusggnw3smir r1wqz3v3 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 in a csv or txt file and use them with the following bulk collect endpoints request type endpoint post /v2/data requests/employee base/ids 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) post requests docid\ hvajncbflry6xoff 548c get requests docid\ sxlwwtymx9hieydap5wso get requests docid\ sxlwwtymx9hieydap5wso