What is the Bright API?
Learn about the purpose of the Bright API and its core functions.
Bright API is our API that allows your Organisation to trigger data syncs and message your Users.
Why do I need to use this?
Syncing
As mentioned in What is Bright Kit?, a cache is used to speed up the loading times for your apps. In order to maintain a healthy cache you will need to implement the Data Synchronisation. Bright API is used to complete this through individual Sync Account requests.
Messaging
Informing your Users of important events, outages, new invoices etc... via the Bright API Send a message endpoint.
Messages are sent immediately and there is currently no support for message scheduling. We recommend you send messages that are of priority normal or default during daytime hours and after your Data Synchronisation is successful.
Updated about 2 months ago