Webhook Subscriptions
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 | /v1/subscriptions/professional_network/member_experience/ids |
POST | /v1/subscriptions/professional_network/member_experience/es_dsl |
POST | /v1/subscriptions/professional_network/member_experience/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.
A webhook message sent to the provided callback URL will inform you of the job position change:
Status | Description |
|---|---|
changed_experience | Job position change (e.g., employee has a new experience record) |
Use the following Clean Employee Collect endpoints to retrieve employee profile data:
Request type | Endpoint |
|---|---|
GET | /v1/professional_network/clean_member/collect/{id} |
Use the following Bulk Collect endpoints to retrieve employee profile data:
Request type | Endpoint |
|---|---|
POST | /v1/professional_network/clean_member/bulk_collect/id_file |
GET | /v1/bulk_collect/{data_request_id}/files |
GET | /v1/bulk_collect/{data_request_id}/files/{file_name} |
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/v1/subscriptions/simulate
Instructions about webhook simulation
We additionally offer endpoints for subscription management.
Use them to list your active subscriptions, see the details, and delete irrelevant ones.
Endpoint | Function |
|---|---|
/v1/subscriptions | See all your subscriptions, their status, creation, and expiration dates. |
/v1/subscriptions/{subsription_id} | See all your subscriptions, their status, used filters or ES DSL schema, creation, expiration dates, and last webhook date. |
DELETE /v1/subscriptions/{subscription_id} | Delete your subscriptions. |
Instructions about subscription management.
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.
To start using our API, you need a (JWT) token. Your account manager or sales representative will generate the token for you upon your request for the API plan.
All requests to the subscription/member_experience endpoints must contain an Authorization header consisting of a Bearer authentication string and the JSON Web Token (JWT).
All Clean data API requests must be made over HTTPS. Requests made over HTTP will fail.
Use any API-compatible tool to authorize and start querying in the API. If you're unsure where to begin, check POST request tutorials:
The number of requests allowed from one client's API token per second is limited.
Request type | Endpoint | Rate limit |
|---|---|---|
POST | /v1/subscriptions/professional_network/member_experience/ids | 9 requests per minute |
POST | /v1/subscriptions/professional_network/member_experience/es_dsl | 9 requests per minute |
POST | /v1/subscriptions/professional_network/member_experience/all | 9 requests per minute |