Rate Limiting

Learn why it is important to use the messaging and sync endpoints with your organisation's limitations in mind.

What is rate limiting?

Rate limiting is used to control the rate of requests sent or received.

Why should I be concerned about this?

Currently Bright Energy does not implement any type of rate limiting for requests towards the Bright API.
This means if you send all of your Sync Account or Send a message requests at the same time they will be processed immediately.

Remember: When a user sees a push notification and opens the app or you start your Data Synchronisation process, we request the user's data via Bright Kit, accessing your Data Layer which ultimately processes the request. If your systems cannot manage the request load there is a real risk of causing upstream issues out of Bright Energy's control.

What can I do to mitigate this risk?

At this time no queuing service is used to mitigate the downstream effects of mass messaging or spikes in user activity.

❗️

It is HIGHLY recommended to small batch or queue your API requests so you do not perform a self-inflicted DDOS attack.

If you choose not to implement this recommendation, it is up to you the Organisation to load test your integration in staging and production prior to Go Live.