Guide to Pumble Addons

Pumble’s integrations seamlessly connect various software tools (e.g., Google Drive, Calendly, Polls, GitHub), making collaboration easier within your workspace. By consolidating all your essential tools, Pumble reduces unnecessary steps and simplifies workflows, creating effective teamwork.

This guide will walk you through the basics of Pumble integrations, from finding and adding addons to understanding their functionality.

Subscription type	Maximum number of addons
Free subscription	Up to 3 addons
Pro plan	Up to 10 addons
Business and Enterprise plans	Unlimited number of addons

Types of addons #

Pumble supports different types of addons. The way an app is built determines its installation, management, and interaction within your workspace.

Find and add addons #

Explore the Pumble App Directory or browse the CAKE.com Marketplace to find and add addons to your workspace:

1. Click on the three dots next to your Workspace name
2. Hover over Workspace settings
3. Click on Configure apps
4. Click on the Install button next to the app you want to add
5. Click Allow on the consent screen to complete the action

You may be redirected to an external website (that app’s website) to allow the installation of the app.

Another way to install Pumble Addons is through the CAKE.com Marketplace. Here’s how you can do it:

1. Click on the three dots next to your Workspace name
2. Hover over Workspace settings
3. Click on Configure apps
4. Click on Browse Marketplace
5. Select the addon you want to install
6. Click Install and allow access request

Upon installation of the addon, authorization is automatically granted. Once an app is installed, other Workspace users need to go to Workspace settings > Configure apps and click Authorize to enable the app for individual use. Authorize is available only for apps already installed in the Workspace.

Request app installation #

When the Request App Approval option is turned on, members can send installation requests for review. 

To turn on app requests:

1. Click on the three dots next to your Workspace name
2. Hover over Workspace settings
3. Click on Configure apps
4. Select the Settings tab
5. Check the box next to Allow members to request apps for approval

Once this setting is turned on, members can request installations by following these steps:

1. Click on the three dots next to your Workspace name
2. Hover over Workspace settings
3. Click on Configure apps
4. Find the app and click Install
5. Review the permissions the app needs
6. Add a message for the approver
7. Click Submit request

Create your own addon from scratch #

To create your own app from scratch, follow these steps:

1. Click on the three dots next to the Workspace name
2. Hover over Workspace settings
3. Click on Configure apps
4. Click on Create app
5. Click Create from scratch

6. Provide Display information details in the dialog box:

• Enter App name
• Upload App avatar
• Enter a Description about your app

7. Configure the app Settings:

• Select User scopes and Bot scopes from the dropdown list
• Select an Event from the dropdown list
• Optional: Toggle the Socket mode switch to ON if you want your app to connect via Socket mode

8. Click Create app

9. Take note of your app credentials

10. Click Install app
System displays the User token and Bot token.

11. Click Close

The app you created will be added to the app list.

The addon permission scopes #

Each addon has specific permission scopes, detailing the information it can access and how that information can be used. Scopes can be related to posting messages, performing actions, and accessing information. Be aware of which information the app can access and what it can do with the information it accesses, such as posting messages, modifying content, or creating channels.

There are two types of scopes:

• User scope
• Bot scope

User scope implies that the addon can perform actions on behalf of users. If the app has a Bot scope, once installed, the addon Bot will be added to your Pumble workspace as a new user.

To view the addon scope:

1. Click on the three dots next to your Workspace name
2. Hover over Workspace settings
3. Click on Configure apps
4. Click on the three dots next to the app in question
5. Select View scopes from the dropdown

Working with installed addons #

How you use and interact with an addon depends on how it was built. Some common features include slash commands, app shortcuts, and bot users.

Slash commands #

Slash commands allow users to interact with the third-party addon by typing a string into the message editor. 

To add a slash command:

1. Type slash icon / in the message editor 
2. Select a command from the list in the pop-up 
3. Type additional text for the app
4. Press Enter to complete the action

Addon shortcuts #

Some addons offer shortcuts for actions in Pumble. There are two types of shortcuts:

• Global shortcuts
• Message shortcuts

To use a global shortcut:

1. Type slash icon / in the message editor
2. Select a command from the list in the pop-up 
3. Press Enter to complete the action

It is not possible to type additional text for communication with the app.

To use a message shortcut:

1. Click on three dots to open a message menu
2. Select one of the listed message shortcuts 

Use the slash icon to find app shortcuts or slash commands.

Addon messages  #

Certain addons have bots that send messages and post in channels. Bots are visible in the Apps section at the bottom of your Pumble sidebar.

Uninstall an addon #

To uninstall a third-party addon:

1. Click on the three dots next to your Workspace name
2. Hover over Workspace settings
3. Click on Configure apps
4. Click on the three dots next to the app you want to uninstall
5. Click Uninstall to complete the action

When you uninstall an addon, a toast message will appear in the bottom right corner. Also, the addon chat will be removed, and you won’t be able to see messages with the addon.

Pumble SDK #

Pumble also offers integration with various platforms through our Software Development Kit (SDK). Comprehensive documentation on how to build a Pumble app in javascript framework can be found here.