Como hospedar um bot do Slack

​

Introdução

​

Pré-requisitos

• Conta Square Cloud: Cadastre-se através da página de cadastro usando seu e-mail.
• Plano ativo: Garante recursos dedicados e desempenho otimizado para seu aplicativo. Confira nossos planos disponíveis e escolha o mais adequado às suas necessidades.

​

Crie o projeto

​

Aplicação de bot no Slack

1. Acesse o Slack API - Your Apps e clique em “Create New App”.
2. Escolha “From scratch” (Do zero), dê um nome ao app e selecione o workspace onde você irá instalá-lo.
3. Na seção “Socket Mode”, ative o Socket Mode e gere um app-level token com o escopo connections:write. Copie-o (ele começa com xapp-): este é o seu SLACK_APP_TOKEN.
4. Na seção “OAuth & Permissions”, adicione os escopos de que o seu bot precisa (ex.: chat:write, app_mentions:read, commands), instale o app no seu workspace e copie o Bot User OAuth Token (ele começa com xoxb-): este é o seu SLACK_BOT_TOKEN.
5. Em “Event Subscriptions”, ative os eventos e assine o evento de bot app_mention. Em “Slash Commands”, crie o comando /hello. Com o Socket Mode ativo, nenhum dos dois pede uma Request URL.

​

Desenvolva o bot

npm init -y
npm install @slack/bolt

const { App } = require('@slack/bolt');

const app = new App({
  token: process.env.SLACK_BOT_TOKEN,
  appToken: process.env.SLACK_APP_TOKEN,
  // Socket Mode: o bot se conecta ao Slack, então não é preciso URL pública
  socketMode: true,
});

// Responde quando mencionado
app.event('app_mention', async ({ event, say }) => {
  await say(`<@${event.user}> Obrigado por me mencionar!`);
});

// Exemplo de comando de barra (slash command)
app.command('/hello', async ({ ack, respond }) => {
  await ack();
  await respond('Olá da Square Cloud!');
});

(async () => {
  await app.start();
  console.log('⚡️ O app Slack Bolt está rodando!');
})();

pip install slack_bolt

import os

from slack_bolt import App
from slack_bolt.adapter.socket_mode import SocketModeHandler

app = App(token=os.environ.get('SLACK_BOT_TOKEN'))

@app.event('app_mention')
def handle_mention(event, say):
    user = event.get('user')
    say(f'<@{user}> Obrigado por me mencionar!')

@app.command('/hello')
def hello_command(ack, respond):
    ack()
    respond('Olá da Square Cloud!')

if __name__ == '__main__':
    # Socket Mode: o bot se conecta ao Slack, então não é preciso URL pública
    SocketModeHandler(app, os.environ.get('SLACK_APP_TOKEN')).start()

slack_bolt

​

Configure a Square Cloud

DISPLAY_NAME=My Slack Bot
MAIN=index.js
MEMORY=512
VERSION=recommended
AUTORESTART=true

DISPLAY_NAME=My Slack Bot
MAIN=app.py
MEMORY=512
VERSION=recommended
AUTORESTART=true

• MAIN é o arquivo que a Square Cloud executa, e MEMORY é a RAM do bot em MB. Bots precisam de pelo menos 256 MB; 512 MB deixa espaço para crescer.
• AUTORESTART=true inicia o bot de novo se ele travar. Veja como funciona o auto restart.
• Não há SUBDOMAIN: no Socket Mode, o bot não precisa de URL pública.

​

Defina os tokens

• Dashboard: na página de upload, abra Configuração avançada e adicione as duas variáveis. Para um bot que já está no ar, adicione-as na página Variáveis de ambiente da aplicação e reinicie o bot.
• CLI: logo depois de enviar o bot (veja Faça o deploy e verifique), defina-as com squarecloud app env set e reinicie o bot:

squarecloud app env set SLACK_BOT_TOKEN=xoxb-your-token SLACK_APP_TOKEN=xapp-your-token
squarecloud app restart

​

O que vai no ZIP

• O seu arquivo principal (index.js ou app.py) e os seus outros arquivos de código.
• package.json ou requirements.txt.
• squarecloud.app.

​

Faça o deploy e verifique

​

Via dashboard

1

Acesse a página de upload

Acesse a página de upload e envie seu arquivo zip.

2

Configure seu ambiente

Após fazer o upload do seu arquivo zip, você precisará configurar o nome, o arquivo principal ou o ambiente de execução e outras configurações do seu projeto.
Se você estiver enviando um projeto web, certifique-se de selecionar “Publicação na Web” e definir um subdomínio para o seu projeto.

3

Faça o deploy do projeto

Por fim, clique no botão “Deploy” para hospedar seu projeto na Square Cloud. Após o deploy, você poderá monitorar o status e os registros do seu projeto no dashboard.

4

Confirme que seu app está no ar

Seu primeiro deploy geralmente leva menos de um minuto. No dashboard, aguarde o status da sua aplicação mudar para em execução e verifique os registros em busca de erros de inicialização.
Se você fez deploy de um site ou API, abra https://<seu-subdominio>.squareweb.app no navegador: você deve ver sua aplicação respondendo. Se você fez deploy de um bot, envie um comando para confirmar que ele está online.

Seu app não está iniciando? Veja o guia de solução de problemas para as causas e correções mais comuns.

​

Via CLI

curl -fsSL https://cli.squarecloud.app/install | bash

npm install -g @squarecloud/cli@latest

squarecloud auth login

squarecloud upload

squarecloud upload --file <caminho/para/zip>

squarecloud app status
squarecloud app logs

​

Teste o bot

1. Nas configurações do app no Slack, em “OAuth & Permissions”, instale o app no workspace (se ainda não tiver instalado).
2. Verifique os logs da aplicação no dashboard da Square Cloud em busca de erros de inicialização. Com o Socket Mode não há Request URL para configurar: o bot se conecta ao Slack assim que inicia.
3. Convide o bot para um canal e, em seguida, mencione-o ou rode o comando /hello para validar as respostas.

https://slack.com/oauth/v2/authorize?client_id=000000000000.000000000000&scope=commands,chat:write,app_mentions:read

​

Erros comuns

​

You must provide an appToken when socketMode is set to true

​

Either an env variable SLACK_BOT_TOKEN or token argument in the constructor is required

​

O bot não responde a menções

​

Use o modo HTTP em vez do Socket Mode

1. Nas configurações do app no Slack, desative o Socket Mode e copie o Signing Secret (em “Basic Information”) para uma variável de ambiente SLACK_SIGNING_SECRET, definida da mesma forma que os tokens.
2. Crie o app com o signing secret em vez do app-level token e escute na porta da variável de ambiente PORT:

const app = new App({
  token: process.env.SLACK_BOT_TOKEN,
  signingSecret: process.env.SLACK_SIGNING_SECRET,
});

(async () => {
  // A Square Cloud define PORT=80
  await app.start(Number(process.env.PORT) || 80);
  console.log('⚡️ O app Slack Bolt está rodando!');
})();

app = App(
    token=os.environ.get('SLACK_BOT_TOKEN'),
    signing_secret=os.environ.get('SLACK_SIGNING_SECRET')
)

if __name__ == '__main__':
    # A Square Cloud define PORT=80
    app.start(port=int(os.environ.get('PORT', 80)))

3. Adicione um SUBDOMAIN ao seu arquivo de configuração (ou selecione “Publicação na Web” e defina um subdomínio ao enviar pelo dashboard) para que o bot tenha uma URL pública. Aplicações web precisam de pelo menos MEMORY=512:

DISPLAY_NAME=My Slack Bot
MAIN=index.js
MEMORY=512
VERSION=recommended
AUTORESTART=true
SUBDOMAIN=my-slack-bot

4. Em “Event Subscriptions” e no comando de barra /hello, defina a Request URL como https://<subdomain>.squareweb.app/slack/events.

​

Próximos passos

​

Contate-nos