specs/models/M_BOTS
Bot
A "Bot" is a combo of an API key and a secret alphanumeric code that allows anybody to read or write to Tulip's database. It must be manually created by a user with access to the Bots page- there are no "default" bots.
Access is controlled via the API key and secret, and can always be turned off at any point. The "secret" will only be displayed once, when the bot is created.
Fields
| Field | Description |
|---|---|
| Name | A text value for the user-facing name |
| Image | An optional image uploaded by the user |
| Scopes | The permissions for the bot. Possibilities include any combination of: read access for apps, machines, tables, and table queries, as well as write access for events, attributes, machines, tables, table queries, and users. |
| API Key | An automatically generated unique alphanumeric string ID for the bot |
| Secret | A text value that will be required every time the API is called. Revealed once during bot creation, then the user must manually add this key to the service that is calling the Tulip API. |
| Auth Header | An automatically generated text value to be included in the header of requests to the Tulip API |
| Creator | The user that created the bot |
| Create Date | The date that the bot was created |
| Enabled | Boolean value for whether the bot is active or not |
Requirements
No requirements