Webhook Subscriptions

Overview

The topic introduces the main information for Base Employee API webhook subscriptions.

Webhook subscriptions

Try to simulate a subscription and explore subscription management options

Functionality

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:

1. Choose the profiles you want to track (using an ID list, search filter query, or Elasticsearch DSL filter query).

2. Provide a callback URL to receive notifications.

3. Receive notifications at your URL and retrieve the data using the Base Employee API collection endpoint or Bulk Collect.

Use the following endpoints to subscribe to employee profile changes:

Request type	Endpoint
POST	/v2/subscriptions/employee_base/ids
POST	/v2/subscriptions/employee_base/filter
POST	/v2/subscriptions/employee_base/es_dsl

After creating a webhook subscription, you will begin receiving updates via webhooks the next day. Updates will be sent daily.

Rate limits

The number of requests allowed is limited.

Request type	Endpoint	Rate limits
POST	/v2/subscriptions/employee_base/ids	18 requests per minute
POST	/v2/subscriptions/employee_base/filter	18 requests per minute
POST	/v2/subscriptions/employee_base/es_dsl	18 requests per minute