Rate Limits

API Limits

Treat the following limits as maximums and please don’t generate unnecessary load. If you suddenly see a rising number of rate limited requests, please contact [email protected]

Limits per account:

• 10 requests/second

We may reduce limits to prevent abuse To request an increased rate limit, please contact [email protected].

The API will respond with HTTP status 429 if the rate limit has been exceeded

And, requests will be blocked for 60 seconds.

You've reached WorkBright's API rate limit, please read the following:
https://developers.workbright.com/docs/rate-limits.
Please contact [email protected] if you need a higher rate-limit.

Caching

We recommend caching the data you need to avoid repeated requests for the same information.

With that in mind, maintaining personal data is a security risk, so we don’t recommend fetching or saving any personal data you don’t need.

Polling vs. Webhooks

Continuous polling of the WorkBright API for new changes is prohibited and can result in a ban at our discretion. An example of this behavior is continuously looping through employees to look for updated data or submissions.

WorkBright provides a comprehensive set of webhooks to notify your application immediately as changes occur.

Can't find the webhook you need? Contact your customer success representative - we're often happy to extend our API.

Backfilling Data

If you're integrating with an existing account and need to sync lots of data, we recommend starting with the Report tool. This can export employee and submission data to CSV or Excel, which may contain the data you need depending on your integration needs.

However, the daily request limit can be extended to allow you to sync your data set.