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 /#functionality main details about the webhook subscription feature in base employee api webhook subscriptions /#credits and tokens 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 /#rate limits information about the enabled api rate limits webhook subscriptions /#setting up webhooks 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 true false 105false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type 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 true false 92false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type possible status for the ids endpoint true falsefalse unhandled content type false unhandled content type false unhandled content type false unhandled content type 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 true false 293false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type 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 true false 87false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type 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