Install API addon<\/h2>\n\n\n\n
Before you can create an API key, you need to install the API addon on your Pumble workspace. <\/p>\n\n\n\n
Here\u2019s how to do this:<\/p>\n\n\n\n
- \n
- Click on + Add apps<\/strong> in the left sidebar<\/li>\n\n\n\n
- Click on Install<\/strong> in the API section<\/li>\n\n\n\n
- Allow permissions <\/li>\n<\/ol>\n\n\n\n
![\"\"](\"https:\/\/pumble.com\/help\/wp-content\/uploads\/2024\/02\/Install-API-addon.gif\")
<\/figure>\n\n\n\nGenerate an API key<\/h2>\n\n\n\n
Once your API addon is installed, you can generate API keys directly in Pumble. <\/p>\n\n\n\n
Here\u2019s how:<\/p>\n\n\n\n
- \n
- Click on API<\/strong> in the left sidebar<\/li>\n\n\n\n
- Select Add API key<\/strong><\/li>\n\n\n\n
- Enter API key name<\/li>\n\n\n\n
- Click Generate<\/strong> to complete the action<\/li>\n<\/ol>\n\n\n\n
![\"\"](\"https:\/\/pumble.com\/help\/wp-content\/uploads\/2024\/02\/Add-new-api-key-1024x509.jpg\")
<\/figure>\n\n\n\nYou\u2019ll receive an ephemeral message containing the generated API key. This message is not visible to other users<\/strong>. Copy this key for future use. The generated key enables interaction with the Addon\u2019s public API, allowing users to send requests and execute various actions within Pumble, including:<\/p>\n\n\n\n
- \n
- Sending messages<\/li>\n\n\n\n
- Leaving a reply to a message<\/li>\n\n\n\n
- Message deletion<\/li>\n\n\n\n
- Adding a reaction to a message<\/li>\n\n\n\n
- Channel creation<\/li>\n\n\n\n
- Listing the messages in a channel (if the channel is private, Addon Bot needs to be a member of that channel)<\/li>\n\n\n\n
- Listing the channels and DMs that belong to the user who created the key<\/li>\n<\/ul>\n\n\n\n
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<\/strong> part.<\/p>\n\n\n\n
Delete API key<\/h2>\n\n\n\n
You can remove an API key by following these steps:<\/p>\n\n\n\n
- \n
- Click on API<\/strong> in the left sidebar<\/li>\n\n\n\n
- Select Delete API key<\/strong><\/li>\n\n\n\n
- Choose a key from the list<\/li>\n\n\n\n
- Click Delete<\/strong> to confirm the action<\/li>\n<\/ol>\n\n\n\n
![\"\"](\"https:\/\/pumble.com\/help\/wp-content\/uploads\/2024\/02\/Delete-api-key-1024x509.jpg\")
<\/figure>\n\n\n\nValid commands<\/h2>\n\n\n\n
There are a few specific actions for interacting with the Pumble API addon. You can use these commands directly in messages:<\/p>\n\n\n\n
- \n
\/api-keys generate<\/code> – 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.<\/li>\n\n\n\n\/api-keys list <\/code>– addon will list all user’s API keys<\/li>\n\n\n\n\/api-keys help<\/code> – to list all valid commands you can use<\/li>\n<\/ul>\n\n\n\n\nRelated Articles<\/h3>\n\n\n\n
- \n
- Guide to Pumble Integrations<\/a><\/li>\n\n\n\n
- Github Integrations<\/a><\/li>\n<\/ul>\n<\/div><\/div>\n","protected":false},"excerpt":{"rendered":"This feature is available on all plans. By using the Pumble API addon, you can i…","protected":false},"author":31,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"_helpful_status":1,"_searchwp_excluded":"","footnotes":""},"categories":[64],"tags":[],"class_list":["post-7104","post","type-post","status-publish","format-standard","hentry","category-automation-workflow-integrations"],"acf":[],"featured_image_src":null,"author_info":{"display_name":"isidora.komaromi@cake.com","author_link":"https:\/\/pumble.com\/help\/author\/isidora-komaromicake-com\/"},"_links":{"self":[{"href":"https:\/\/pumble.com\/help\/wp-json\/wp\/v2\/posts\/7104","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/pumble.com\/help\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/pumble.com\/help\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/pumble.com\/help\/wp-json\/wp\/v2\/users\/31"}],"replies":[{"embeddable":true,"href":"https:\/\/pumble.com\/help\/wp-json\/wp\/v2\/comments?post=7104"}],"version-history":[{"count":121,"href":"https:\/\/pumble.com\/help\/wp-json\/wp\/v2\/posts\/7104\/revisions"}],"predecessor-version":[{"id":12916,"href":"https:\/\/pumble.com\/help\/wp-json\/wp\/v2\/posts\/7104\/revisions\/12916"}],"wp:attachment":[{"href":"https:\/\/pumble.com\/help\/wp-json\/wp\/v2\/media?parent=7104"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/pumble.com\/help\/wp-json\/wp\/v2\/categories?post=7104"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/pumble.com\/help\/wp-json\/wp\/v2\/tags?post=7104"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}
- Select Delete API key<\/strong><\/li>\n\n\n\n
- Click on API<\/strong> in the left sidebar<\/li>\n\n\n\n
- Select Add API key<\/strong><\/li>\n\n\n\n
- Click on Install<\/strong> in the API section<\/li>\n\n\n\n