Pumble API Overview

Esta función está disponible en todos los planes.

By using the Pumble API addon, you can interact with Pumble’s API documentation without using any complex authentication processes. This addon lets you generate an API key that allows you to send messages, reactions, and more via simple HTTP requests.

Install API addon #

Before you can create an API key, you need to install the API addon on your Pumble workspace.

Aquí es cómo hacerlo:

1. Click on + Add apps in the left sidebar
2. Click on Install in the API section
3. Allow permissions 

Generate an API key #

Once your API addon is installed, you can generate API keys directly in Pumble.

Here’s how:

1. Click on API in the left sidebar
2. Select Add API key
3. Enter API key name
4. Click Generate 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:

• Envío de mensajes
• Respuesta a un mensaje
• Eliminación de mensajes
• Adding a reaction to a message
• Creación de canales
• Listing the messages in a channel (if the channel is private, Addon Bot needs to be a member of that channel)
• Listado de los canales y mensajes directos que pertenecen al usuario que creó la clave

The full list of available actions is available in the Swagger documentation. You can also use the documentation in Swagger, just enter your API key in the Authorize part.

Delete API key #

You can remove an API key by following these steps:

1. Click on API in the left sidebar
2. Select Delete API key
3. Choose a key from the list
4. Click Delete to confirm the action

Comandos válidos #

There are a few specific actions for interacting with the Pumble API addon. You can use these commands directly in messages:

• /api-keys generate – el complemento generará claves API para ese usuario en particular y las almacenará en su base de datos. Los usuarios pueden generar tantas claves API como quieran
• /api-keys list – el complemento enumerará todas las claves API del usuario
• /api-keys help – para enumerar todos los comandos válidos que puedes utilizar