Webhook Subscriptions

employee api will be deprecated on august 6th until then, you must transfer to a base employee api docid\ gobtmn jebqrtgr8akb1w read all about the benefits and changes base employee api docid\ zhyxkcw5ssxx1p94ejuwl webhooks will stop working on may 9th overview webhook subscription endpoints are an extension of employee api and include seven post endpoints three post endpoints enable you to set up webhooks to be notified about changes in employee profiles, referred to as subscriptions in this article you can subscribe to notifications of changes by submitting a list of member ids selecting profiles using search filters selecting profiles using elasticsearch schema (es dsl) additionally, we provide options to try out the feature and manage your subscriptions using four subscription endpoints webhook subscriptions docid 9ct5gwom6xlqfuyg9ti main details about the webhook subscription feature in employee api webhook subscriptions docid 9ct5gwom6xlqfuyg9ti information about api tokens and credits webhook subscriptions docid 9ct5gwom6xlqfuyg9ti information about authorization flow in the api webhook subscriptions docid 9ct5gwom6xlqfuyg9ti information about the enabled api rate limits webhook subscriptions docid 9ct5gwom6xlqfuyg9ti tutorials for setting up webhooks using three different methods functionality the subscription is valid for 91 days during this period, you'll receive notifications about all changes in the selected employee profiles employee api subscription feature (or webhooks) enables you to track updates in selected profiles by setting up a callback url to receive change notifications choose the profiles you want to track (using an id list, search filter query, or es dsl filter query) provide a callback url to receive notifications receive notifications to your url and retrieve the data using the employee api collection endpoint or bulk collect use the following endpoints to subscribe to employee profile changes request type endpoint post /v2/subscriptions/member/id file post /v2/subscriptions/member/filter post /v2/subscriptions/member/es dsl after creating a webhook subscription, you will begin receiving updates via webhooks the next monday if you happen to set up webhooks on monday before 8 00 am (utc), you will start receiving notifications on the same day updates will be sent once a week statuses you will receive status updates indicating various types of changes in profiles matched by filters or ids different endpoints have different statuses listed below 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 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 employee api collection endpoints possible status for the id file 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 employee api collection endpoints 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\ vwgwc6a7qrkatm8wplvbv subscription simulation instructions 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/{subscription 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\ fa51h9ikjv4gcd zclbzm subscription management details credits and tokens use the same token you received for employee api usage subscription requests do not consume credits like regular employee api endpoints the subscription feature is only accessible to the 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 limits post /v2/subscriptions/member/id file 9 requests per minute post /v2/subscriptions/member/filter 9 requests per minute post /v2/subscriptions/member/es dsl 9 requests per minute setting up webhooks check the endpoint usage tutorials in the following articles subscribe to changes docid\ mz1khqqe2pfktpx6m04ir subscribe to changes docid\ mz1khqqe2pfktpx6m04ir subscribe to changes docid\ mz1khqqe2pfktpx6m04ir