This is a lightweight and unassuming wrapper for the Vestaboard API. This project is open source and no payment is necessary to use - project donations are always appreciated to help fund this effort. If interested, you can view the donation page here.
By Shane Sutro and contributors
You can view more information about Vestaboard's API here. Disclaimer
According to Vestaboard's documentation, software that utilizes the API is considered an installable
, and as such must be connected to a Vestaboard via an installation
.
Each Board subscribes to an installable
via an installation
and as such is able to recieve a message
. While I won't get into detail on how these correlate, know that you must first create an installable
via Vestaboard's API. You'll need to create an account and register your installable
to your board.
Once created, you will need to store your API Key and API Secret - you'll need this to communicate with your board. During this process, you will be prompted to select which board you'd like to install this installable
onto - this is what creates the Subscription ID behind the scenes. Read more below.
- Download and install into your project file
- Via
npm
:
npm install vestaboard
Interested in contributing to this project? Send a PR with changes and I'd be happy to review! If you're having trouble with this library, be sure to open an issue so that I can look into the problem. Any details that can be provided alongside the problem would be greatly appreciated. Thanks!
Note: this project is maintaned by independent developers and is not sponsored by nor affiliated with Vestaboard, Inc. I am unable to make changes to their API or answer questions about the company, upcoming API support, or future-state plans. For questions regarding Vestaboard's API, privacy policies, or to request assistance with your board, please get in touch with them here.