Getting an API Key

An API key is needed to run your Teamwire bot. This API key consists of two parts, an App ID and a Secret.

Info

A Teamwire admin account is required in order to create API keys. If your Teamwire installation is running in the Teamwire public cloud, you can access the dashboard here.

Otherwise, if your Teamwire installation is running in a private cloud or on-premise, contact your IT admin to get access to the dashboard.

Creating a new key

1. Log in to your Teamwire dashboard
2. Go to the App Integrations panel from the side menu
3. Click the button "Add App Integration"

The Add App Integration dialog appears with three fields:

• Organisation: Only visible to super-admins. The organization in which the bot is created. By default, it is created in your user's organization.
• Name: Name that identifies the bot.
• Comment: Optional. Use this field to add an internal comment; it won't be visible to Teamwire users.

Note

The Organization field is only available to super-admins. Regular admins won't see this field, and the bot will be created for their organization.

Tip

Bots appear in all Teamwire apps as bot users, identified by the name you set in this field followed by the word "Bot". For example, a bot named "Weather" will appear in Teamwire apps as "Weather Bot".

Press the Create button. The new API key will be created and made available under the Credentials tab.

App Integration credentials consist of two parts, the App ID and the Secret. You'll need both for your application to successfully connect to the Teamwire API.

Warning

Please keep both the App ID and Secret confidential, as anyone gaining access to them could use them to send unsolicited messages to your organisation's users.

Setting up bot visibility

A newly created bot has its visibility restricted by default, which means that no user can see it.

In the Visibility section, you can restrict the bot to selected circles or make it publicly available to all users in the organization.

In order to make the bot available to the entire organization, just select the "All users" radio button.

Tip

Restricting visibility to some preselected circles can be very useful during development. Create a "Bots developers" circle in your dashboard with the users who will participate in its development. Only those users will be able to use the bot.

Once the bot is ready for testing, you could create a new "Bots testers" circle and add it to the bot's circle list.

Finally, when the bot is ready for deployment, just uncheck the visibility restriction and the bot will be synchronized to the entire organization.