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).
The subscription is valid for 91 days. During this period, you'll receive notifications about all changes in the selected employee profiles.
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.
Try the feature
Still not sure if this feature is right for you? Use /v2/subscriptions/simulate endpoint to simulate an active webhook subscription.
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.
Last updated
Was this helpful?