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 /#post requests using elasticsearch schema use elasticsearch to specify the changes you want to be notified about subscribe to changes /#post requests using search filters use search filters to specify the changes you want to be notified about subscribe to changes /#post requests using ids submit profile ids to be notified of changes in that specific range post requests using elasticsearch schema use endpoint /v2/subscriptions/member/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 schema elasticsearch schema "mappings" { "properties" { "id" { "type" "long" }, "name" { "type" "text" }, "first name" { "type" "text" }, "last name" { "type" "text", }, "title" { "type" "text" }, "user generated headline" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" } } }, "url" { "type" "text", "fields" { "exact" { "type" "keyword", } } }, "hash" { "type" "keyword", }, "location" { "type" "text" }, "industry" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" } } }, "summary" { "type" "text" }, "connections" { "type" "keyword", }, "recommendations count" { "type" "long", "null value" 1 }, "logo url" { "type" "keyword", }, "last response code" { "type" "long", "null value" 1, }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "outdated" { "type" "byte", }, "deleted" { "type" "byte", }, "country" { "type" "keyword", "null value" "null" }, "connections count" { "type" "long", "null value" 1 }, "experience count" { "type" "long", "null value" 1 }, "member shorthand name" { "type" "keyword" }, "member shorthand name hash" { "type" "keyword", }, "canonical url" { "type" "text", "fields" { "exact" { "type" "keyword" } } }, "canonical hash" { "type" "keyword" }, "canonical shorthand name" { "type" "keyword" }, "canonical shorthand name hash" { "type" "keyword" }, "member also viewed collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "url" { "type" "keyword" }, "title" { "type" "text" }, "location" { "type" "text" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss", }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" } } }, "member awards collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "title" { "type" "text" }, "issuer" { "type" "text" }, "description" { "type" "text" }, "date" { "type" "keyword" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" } } }, "member certifications collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "name" { "type" "text" }, "authority" { "type" "text" }, "url" { "type" "keyword" }, "date from" { "type" "date", "format" "mmmm uuuu||uuuu", "null value" "1000" }, "date to" { "type" "date", "format" "mmmm uuuu||uuuu", "null value" "1000" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss", }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss", }, "deleted" { "type" "byte" } } }, "member courses collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "position" { "type" "text" }, "courses" { "type" "text" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" } } }, "member courses suggestion collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "course suggestion id" { "type" "long" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" }, "member courses suggestion list" { "properties" { "id" { "type" "long" }, "name" { "type" "keyword" }, "hash" { "type" "keyword" }, "url" { "type" "keyword" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" } } } } }, "member education collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "title" { "type" "text", "fields" { "raw" { "type" "keyword", "null value" "null" } } }, "subtitle" { "type" "text" }, "date from" { "type" "date", "format" "mmmm uuuu||uuuu", "null value" "1000" }, "date to" { "type" "date", "format" "mmmm uuuu||uuuu", "null value" "1000" }, "activities and societies" { "type" "text" }, "description" { "type" "text" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" }, "school url" { "type" "text", "fields" { "exact" { "type" "keyword" } } } } }, "member experience collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "title" { "type" "text" }, "location" { "type" "text", }, "company name" { "type" "text", "fields" { "raw" { "type" "keyword", "null value" "null" } } }, "company url" { "type" "keyword" }, "company url shorthand name" { "type" "keyword" }, "company url canonical shorthand name" { "type" "keyword" }, "company industry" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" } } }, "company website" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" }, "domain only" { "type" "text" } } }, "company employees count" { "type" "unsigned long" }, "company size" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" } } }, "date from" { "type" "date", "format" "mmmm uuuu||uuuu", "null value" "1000" }, "date to" { "type" "date", "format" "mmmm uuuu||uuuu", "null value" "1000" }, "duration" { "type" "text" }, "description" { "type" "text" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" }, "order in profile" { "type" "long" }, "company id" { "type" "long" } } }, "member groups collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "name" { "type" "keyword" }, "url" { "type" "keyword" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" } } }, "member interests collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "interest id" { "type" "long" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" }, "member interest list" { "properties" { "id" { "type" "long" }, "interest" { "type" "keyword" }, "hash" { "type" "keyword" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" } } } } }, "member languages collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "language id" { "type" "long" }, "proficiency id" { "type" "long" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" }, "member language list" { "properties" { "id" { "type" "long" }, "language" { "type" "keyword" }, "hash" { "type" "keyword" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" } } }, "member language proficiency list" { "properties" { "id" { "type" "long" }, "proficiency" { "type" "keyword" }, "hash" { "type" "keyword" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" } } } } }, "member organizations collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "organization" { "type" "keyword" }, "position" { "type" "keyword" }, "description" { "type" "text" }, "date from" { "type" "keyword" }, "date to" { "type" "keyword" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" } } }, "member patents collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "title" { "type" "text" }, "status id" { "type" "long" }, "inventors" { "type" "text" }, "date" { "type" "date", "format" "mmmm uuuu||uuuu", "null value" "1000" }, "url" { "type" "keyword" }, "description" { "type" "text" }, "valid area" { "type" "text" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" }, "member patent status list" { "properties" { "id" { "type" "long" }, "status" { "type" "keyword" }, "hash" { "type" "keyword" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" } } } } }, "member posts see more urls collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "url" { "type" "keyword" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" } } }, "member projects collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "name" { "type" "text" }, "url" { "type" "keyword" }, "description" { "type" "text" }, "date from" { "type" "date", "format" "mmmm uuuu||uuuu", "null value" "1000" }, "date to" { "type" "date", "format" "mmmm uuuu||uuuu", "null value" "1000" }, "team members" { "type" "text" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" } } }, "member publications collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "title" { "type" "text" }, "publisher" { "type" "keyword" }, "date" { "type" "date", "format" "mmmm uuuu||uuuu", "null value" "1000", }, "description" { "type" "text" }, "authors" { "type" "text" }, "url" { "type" "keyword" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" } } }, "member recommendations collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "recommendation" { "type" "text" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" } } }, "member similar profiles collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "url" { "type" "keyword" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" } } }, "member skills collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "skill id" { "type" "long" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" }, "member skill list" { "properties" { "id" { "type" "long" }, "skill" { "type" "text" }, "hash" { "type" "keyword" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" } } } } }, "member test scores collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "name" { "type" "text" }, "date" { "type" "keyword" }, "description" { "type" "text" }, "score" { "type" "keyword" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" } } }, "member volunteering cares collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "care id" { "type" "long" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" }, "member volunteering care list" { "properties" { "id" { "type" "long" }, "care" { "type" "keyword" }, "hash" { "type" "keyword" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" } } } } }, "member volunteering opportunities collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "opportunity id" { "type" "long" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" }, "member volunteering opportunity list" { "properties" { "id" { "type" "long" }, "opportunity" { "type" "keyword" }, "hash" { "type" "keyword" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" } } } } }, "member volunteering positions collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "organization" { "type" "text" }, "role" { "type" "keyword" }, "cause id" { "type" "long" }, "date from" { "type" "keyword" }, "date to" { "type" "keyword" }, "duration" { "type" "keyword" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" }, "description" { "type" "text" }, "organization url" { "type" "keyword" }, "member volunteering positions cause list" { "properties" { "id" { "type" "long" }, "cause" { "type" "keyword" }, "hash" { "type" "keyword" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" } } } } }, "member volunteering supports collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "support id" { "type" "long" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" }, "member volunteering support list" { "properties" { "id" { "type" "long" }, "support" { "type" "keyword" }, "hash" { "type" "keyword" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" } } } } }, "member websites collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "website" { "type" "keyword" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" } } }, "member hidden status collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "is hidden" { "type" "byte" }, "deleted" { "type" "byte" } } } } } you can find more information on the employee api elasticschema and its usage in the elasticsearch dsl docid\ totbwg4fx7cwdhfpvjz4x article 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/member/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/member/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" { "name" { "query" "john smith", "operator" "and" } } } } }' insert your api key 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 getting updates on select profiles the upcoming monday if you happen to set up webhooks on monday before 8 00 am (utc), you will start receiving notifications on the same day 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 (member) ids visible in the webhook text post requests using search filters use endpoint /v2/subscriptions/member/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 last updated gte and last updated at lte search endpoint filters search endpoint filters { "name" "string", "title" "string", "location" "string", "industry" "string", "summary" "string", "deleted" true, "country" "string", "skill" "string", "certification name" "string", "experience title" "string", "experience company name" "string", "experience company exact name" "string", "experience company website url" "string", "experience company website exact url" "string", "experience company linkedin url" "string", "experience company industry" "string", "experience company size" "string", "experience company employees count gte" 0, "experience company employees count lte" 0, "experience date from" "string", "experience date to" "string", "experience description" "string", "experience deleted" true, "experience company id" 0, "active experience" true, "keyword" "string", "education institution name" "string", "education institution exact name" "string", "education program name" "string", "education description" "string", "education date from" "string", "education date to" "string", "education institution linkedin url" "string", "is hidden" true } you can find more information on the employee api filters in the search filters docid\ fe3vypmjtz7kpuknio03h article 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/member/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/member/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 getting updates on select profiles the upcoming monday if you happen to set up webhooks on monday before 8 00 am (utc), you will start receiving notifications on the same day 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 (member) ids visible in the webhook text post requests using ids use the endpoint /v2/subscriptions/member/id file 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 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/member/id file' \\ 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 getting updates on select profiles the upcoming monday if you happen to set up webhooks on monday before 8 00 am (utc), you will start receiving notifications on the same day 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 (member) 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 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 function endpoint get /v2/member/collect/{member id} collect docid 9rn4zrf0wqnhhjkbkztqs 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 (member) ids in a csv or txt file and use them with the following bulk collect endpoints request type endpoint post /v2/data requests/member/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) bulk collect docid 4jpuvgldl7vvnprof 5rh get requests docid\ tp1brmjkfppkx3za0eo d get requests docid\ tp1brmjkfppkx3za0eo d