Webhooks

Introduction

A webhook subscription allows to receive real-time notifications whenever specific events occur. Instead of constantly polling an API to check for updates, the system automatically sends event data to a predefined URL (the webhook endpoint). Currently, webhook subscriptions are available for Clean Employee API and Base Employee API.

The subscription is valid for 91 days. During this period, you'll receive notifications about all changes in the selected employee profiles.

Try the feature

Still not sure if this feature is right for you? Use /v2/subscriptions/simulate endpoint to simulate an active webhook subscription.

Simulate a subscription

Statuses

You will receive status updates indicating various types of changes in profiles matched by Search filters and Elasticsearch queries or IDs.

Possible statuses for Search filter and Elasticsearch DSL endpoints

Status	Description
started_matching_query	Profiles that previously did not match your filters have been updated to meet your criteria Example: the job title was updated to Project Manager.
stopped_matching_query	Profiles that once matched your filters but have since been updated to no longer match Example: 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 GET or collection endpoints.

Possible status for the IDS endpoint

Status	Description
changed	Profiles that have undergone non-specified changes. To see the exact changes, you will need to query them using Bulk Collect GET or collection endpoints.

Manage the subscriptions

There are additional endpoints for subscription management. Use them to list your active subscriptions, see the details, renew subscriptions and delete irrelevant ones.

Learn how to manage your subscriptions

Credits

Subscription requests do not consume credits like regular 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.