Settings - Bots

Overview

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.

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.

The page also links to the official API documentation, which is listed under the route "/apiDocs" and shows different examples of how to use the API. It can be accessed via the link "API Documentation" in the top right of the screen.

Model/Page Connections

Bot

Create

• A user can create a bot by pressing the "Create Bot" button in the top right of the screen.

Edit

• A user can edit all properties of the bot except for the API Key, secret and auth header by clicking the "pencil" icon next to each bot on the right side of the screen.

View

• A user can view all bots in the account on the list in the middle of the screen. They can view the current scopes for each bot by clicking the "Edit" pencil next to each bot.

Deactivate

• A user can turn off a bot's access to Tulip by flipping the toggle in the "Enabled" column next to each bot to the left, or "disabled", position. Bots cannot be deleted.

Pages

This page can be accessed from:

• Settings: Account

User Permissions

A user with “edit” permissions for account settings can view, edit, create and deactivate bots.

Tests

Requirements