Webhook Subscriptions

overview webhook subscriptions are a clean employee api feature that includes seven post endpoints three experience changes endpoints enable you to set up webhooks to be notified about job position (experience) changes in select employee profiles you can subscribe to notifications of select profiles by submitting a list of employee ids selecting profiles using elasticsearch schema (es dsl) you can also choose to be notified of work experience changes in any employee profile additionally, we provide options to try out the feature and manage your subscriptions using four subscription endpoints webhook subscriptions docid\ tgkgxfefx8v9dlg9yv4fe main details about the subscription feature in clean data api webhook subscriptions docid\ tgkgxfefx8v9dlg9yv4fe information about api tokens and credits webhook subscriptions docid\ tgkgxfefx8v9dlg9yv4fe information about authorization flow in the api webhook subscriptions docid\ tgkgxfefx8v9dlg9yv4fe information about the enabled api rate limits webhook subscriptions docid\ tgkgxfefx8v9dlg9yv4fe tutorials for setting up webhooks using three different methods functionality the subscription is valid for 91 days during this period, you'll receive notifications of job position (experience) changes in selected employee profiles clean employee api webhook feature enables you to track job position (experience) changes in select profiles by setting up a callback url to receive change notifications you can choose the profiles you want to track (using an id list or es dsl filter query) or track the changes of all profiles in our database provide a callback url to receive notifications receive notifications to your url and retrieve the data using the clean data api collection endpoint or bulk collect use the following endpoints to subscribe to job position changes function endpoint post /v2/subscriptions/experience changes/ids post /v2/subscriptions/experience changes/es dsl post /v2/subscriptions/experience changes/all after creating a webhook subscription, you will receive updates via webhooks next monday updates will be sent once a week if you choose to track all work experience changes in all available employee profiles, expect to receive 500,000 or more update messages in a week statuses possible s tatuses for filter and es dsl endpoints status description started matching query started matching query profiles that previously did not match your filters have been updated to meet your criteria (e g , the job title was updated to project manager ) stopped matching query stopped matching query profiles that once matched your filters but have since been updated to no longer match (e g , job title changed from project manager to scrum master ) changed changed profiles that have undergone non specified changes to see the exact changes, you will need to query them using bulk collect get or base employee api collection endpoints possible status for the ids endpoint status description changed changed profiles that have undergone non specified changes to see the exact changes, you will need to query them using bulk collect get or base employee api collection endpoints data collection use the following clean employee collect endpoints to retrieve employee profile data request type endpoint get /v2/employee clean/collect/{employee id} use the following bulk collect endpoints to retrieve employee profile data 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} trying out the feature since we send information via webhooks once a week, you won't be able to see how the feature works right away after ordering a subscription use the simulate endpoint to simulate an active webhook subscription simulate endpoint url https //api coresignal com/cdapi/v2/subscriptions/simulate subscription simulation docid\ ilrqgc7 5gxwvpo0r8r6 instructions about webhook simulation subscription management we additionally offer endpoints for subscription management use them to list your active subscriptions, see the details, and delete irrelevant ones endpoint function /v2/subscriptions see all your subscriptions, their status, creation, and expiration dates /v2/ subscriptions/{subsription id} see all your subscriptions, their status, used filters or es dsl schema, creation, expiration dates, and last webhook date delete /v2/subscriptions/{subscription id} delete your subscriptions subscription management docid\ roe1urg9 di4bu59qj7bn instructions about subscription management credits and tokens use the same token you received for clean data api usage subscription requests do not consume credits like regular clean data api endpoints the subscription feature is only accessible to users of higher tier api plans to learn more about accessing this feature, contact your account manager rate limits the number of requests allowed from one client's api token per second is limited request type endpoint rate limit post /v2/subscriptions/experience changes/ids 9 requests per minute post /v2/subscriptions/experience changes/es dsl 9 requests per minute post /v2/subscriptions/experience changes/all 9 requests per minute