Webhooks
The subscription is valid for 91 days. During this period, you'll receive notifications about all changes in the selected employee profiles or specific data points determined by the filters used.
The Employee API webhook feature 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 changes:
Function | Endpoint |
|---|---|
POST | /v1/subscriptions/professional_network/employee/id_file |
POST | /v1/subscriptions/professional_network/employee/filter |
POST | /v1/subscriptions/professional_network/employee/es_dsl |
After creating a webhook subscription, you will begin receiving updates via webhooks next Monday. Updates will be sent once a week.
You will receive status updates indicating various types of changes in profiles matched by filters or IDs.
Different endpoints have different statuses listed below:
Status | Description |
|---|---|
Added | 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). |
Removed | 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 | Profiles that have undergone non-specified changes. To see the exact changes, you will need to query them using Bulk Collect or Employee API collection endpoints. |
Status | Description |
|---|---|
Changed | Profiles that have undergone non-specified changes. To see the exact changes, you will need to query them using Bulk Collect or Employee API collection endpoints. |
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.
Every search and collect response contains an X-Credits-Remaining header that shows the number of credits left in your account.
You can find the credit balance by clicking Header in the Postman application.
Example of remaining credits header:
To start using our API, you need a (JWT) token. Your account manager or sales will generate the token for you upon your request for the API plan.
All requests to the Webhook endpoints must contain an Authorization header consisting of a Bearer authentication string and the JSON Web Token (JWT).
All Employee 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 out the authorization tutorials:
Webhook endpoints restrict the number of requests allowed per second for each client's API token.
Function | Endpoint | Rate limit |
|---|---|---|
POST | /v1/subscriptions/professional_network/employee/id_file | 9 requests per minute |
POST | /v1/subscriptions/professional_network/employee/filter | 9 requests per minute |
POST | /v1/subscriptions/professional_network/employee/es_dsl | 9 requests per minute |
Check the endpoint usage tutorials in the following articles: