Webhook Subscriptions

when creating a new subscription based on es dsl query to the new base employee endpoints, we strongly advise including the following clause to your query "term" { "is parent" 1 } this ensures that you get the most out of our new systematic approach to exclude duplicate records, which we can resolve with the same profile overview webhook subscription endpoints are an extension of base 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 employees' 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\ ut xggm ibmtusznmsqsc main details about the webhook subscription feature in base employee api webhook subscriptions docid\ ut xggm ibmtusznmsqsc information about api tokens and credits webhook subscriptions docid\ ut xggm ibmtusznmsqsc authorization docid\ tktw cgpqdgjronl09vnj information about authorization flow in the api webhook subscriptions docid\ ut xggm ibmtusznmsqsc information about the enabled api rate limits webhook subscriptions docid\ ut xggm ibmtusznmsqsc 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 base 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/employee base/ids post /v2/subscriptions/employee base/filter post /v2/subscriptions/employee base/es dsl after creating a webhook subscription, you will begin receiving updates via webhooks the next day updates will be sent daily 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 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 trying out the feature use the simulate endpoint to simulate an active webhook subscription simulate endpoint url https //api coresignal com/cdapi/v2/subscriptions/simulate subscription simulation docid\ ubtjtkuptye9iz0xsgiii 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/{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\ uucjk2eqgjjgy1vlpvkov subscription management details credits and tokens use the same token you received for base employee api usage subscription requests do not consume credits like regular base employee 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 limits post / v2/subscriptions/employee base/ids 18 requests per minute post /v2/subscriptions/employee base/filter 18 requests per minute post /v2/subscriptions/employee base/es dsl 18 requests per minute setting up webhooks check the endpoint usage tutorials in the following articles subscribe to changes docid\ cp99d8xsk0zim4xwtfwyi subscribe to changes docid\ cp99d8xsk0zim4xwtfwyi subscribe to changes docid\ cp99d8xsk0zim4xwtfwyi