API Integration

Pumble API Addon offers a seamless solution for users to interact with the Pumble API without the need for complex authentication processes. With this addon, users can generate API keys effortlessly, allowing them to send messages, reactions, and more via simple HTTP requests. Here’s how to get started:

1. Click on +Add apps button at the bottom of the left sidebar
   
   
   
2. Click on Install button next to the API app 
   
   A new tab will open with the consent form and integration specifics.
   
   It’s possible that the app has already been installed on your workspace by another user, and you will need to authorize it so that you can use it. To do it, click on the Authorize button next to the app name.
   
   
3. Select the Workspace from the dropdown
   
   It is important that you are logged in to the Pumble Workspace that you choose from the dropdown.
   
   
4. Click Allow to complete the installation

Valid commands #

There are a few specific actions that can be used to interact with API integration on Pumble:

• /api-keys generate – addon will generate API keys for that particular user and store it in their database. Users can generate as much API keys as they want to.
• /api-keys list – addon will list all user’s API keys
• /api-keys help – to list all valid commands you can use

Generate API keys #

To generate an API key, do the following:

1. Type /api-keys generate in the message editor in any channel (you can also add a note next to it)
2. Press enter/Send button to complete the action

You’ll receive an ephemeral message containing the generated API key. This message is not visible to other users. Copy this key for future use. The generated key enables interaction with the Addon’s public API, allowing users to send requests and execute various actions within Pumble, including:

• Sending messages
• Leaving a reply to a message
• Message deletion
• Adding reaction to a message
• Channel creation
• Listing the messages in a channel (if the channel is private, Addon Bot needs to be the member of that channel)
• Listing the channels and DMs that belong to the user who created the key

The full list of available actions can be viewed in the Swagger documentation.

API integration can be used, for example, if you run a busy e-commerce website, and you want to keep your customer support team informed about new orders in real-time. By integrating Pumble with API, you can set up an automated notification system that alerts your customer support team in Pumble channels whenever a new order is placed.

Interact with the public API of the Addon #

You can interact with the Addon’s public API to send messages and perform other actions in Pumble using the generated API key.

To do this, you need to send a request via an API platform (e.g., Insomnia, Postman, JMeter).

For the full suite of the supported APIs, see the documentation here. https://pumble-api-keys.addons.marketplace.cake.com/

You can also use the documentation in Swagger, just enter your API key in the Authorize part.