Criar fluxos de trabalho que se iniciam com um webhook

Quem pode usar este recurso?
  • Todos os membros (por padrão)
  • Disponível em planos pagos.

Os fluxos de trabalho são tarefas ou processos automatizados de várias etapas que são executados diretamente no Slack. Eles podem ter a simplicidade ou a complexidade que você quiser e normalmente não exigem a escrita de nenhum código. Para criar um fluxo de trabalho que é executado quando ocorre um evento em um serviço externo, você pode usar um webhook.

Confira tudo o que você precisa para começar

  • Saber como enviar solicitações HTTP por linha de comando ou outra ferramenta
  • Entender os webhooks recebidos. Confira orientações sobre isso na documentação da API do Slack ou peça ajuda a um desenvolvedor da sua equipe

Observação: os proprietários e administradores podem restringir o acesso para a criação de fluxos de trabalho com webhooks. Se você não encontrar essa opção no criador de fluxo de trabalho, entre em contato com um proprietário ou administrador para pedir ajuda.


Configuração do fluxo de trabalho

Noções básicas do fluxo de trabalho com webhook

No Slack, todos os fluxos de trabalho são iniciados com acionadores. Para acionar um fluxo de trabalho com um webhook, você deverá configurar o webhook para executar o fluxo de trabalho quando ocorrer um evento específico em outro serviço. Você pode, por exemplo, criar um fluxo de trabalho que poste uma mensagem em um canal específico quando houver um problema com o seu site para que a equipe de engenharia possa investigar.

Configurar o webhook

O serviço externo que você usa para criar e configurar o webhook deve permitir que você faça uma solicitação de HTTP POST ao Slack quando ocorrerem determinados eventos. O Slack gerará um URL de solicitação exclusivo para o seu fluxo de trabalho após a publicação dele, e você poderá configurar o webhook para transmitir as informações ao Slack no corpo da solicitação de HTTP. Qualquer dado que o webhook enviar ao Slack poderá ser referenciado nas etapas que você adicionar ao seu fluxo de trabalho com a criação de variáveis.

Dica: Se você tiver dúvidas sobre como configurar o webhook, recomendamos que peça ajuda a um desenvolvedor da sua equipe ou consulte alguma documentação de suporte fornecida pelo serviço que você usa, como o Postman ou o Zapier.

Criar variáveis personalizadas

É possível adicionar até 20 variáveis para transmitir dados de outros serviços para o Slack e incluir informações específicas do Slack (como nomes exibidos ou endereços de e-mail) nas etapas que você adicionar ao fluxo de trabalho.

Para criar uma variável personalizada, você deverá adicionar um par chave-valor no Criador de fluxo de trabalho como variável baseada em texto. Depois de adicionar uma variável, você verá uma visualização do corpo HTTP de modo a verificar se os valores correspondem às saídas JSON no outro serviço que você está conectando ao Slack com o webhook. Leve em consideração que, no momento, não é possível usar estruturas JSON agrupadas em variáveis de fluxos de trabalho.

No exemplo abaixo, se o usuário, a gravidade e a descrição incident_description não fossem enviadas com a solicitação de webhook, ocorreria uma falha no fluxo de trabalho.

Configuração do webhook no criador de fluxo de trabalho mostrando a URL do webhook e as variáveis personalizadas

Dica: Se você precisar adicionar, remover ou modificar variáveis a qualquer momento, abra o fluxo de trabalho no criador de fluxo de trabalho. Em seguida, clique no  ícone de lápis ao lado de Começa com um webhook para fazer suas alterações. Você também precisará certificar-se de que qualquer alteração feita às variáveis seja refletida no serviço externo do qual a solicitação do webhook é enviada.

Obter a URL de solicitação da Web 

Após a publicação do fluxo de trabalho, o Slack gerará um URL de solicitação exclusivo que você poderá adicionar ao webhook para garantir que o POST que você configurou seja enviado para o canal correto. Os URLs de solicitação começam com https://hooks.slack.com/triggers, seguidos por uma string de caracteres aleatória.

Mantenha a URL de solicitação protegida, pois qualquer pessoa com o link poderá acionar o fluxo de trabalho.

Observação: os fluxos de trabalho de webhook estão limitados a uma solicitação por segundo. Saiba mais sobre os limites de taxas na API do Slack.


Adicionar etapas para concluir seu fluxo de trabalho

Adicionar etapas

Depois de ter configurado o webhook e criado todas as variáveis que você quiser usar, está tudo pronto para adicionar as etapas ao fluxo de trabalho

  1. Abra o fluxo de trabalho no criador de fluxo de trabalho. 
  2. Clique em Adicionar etapa
  3. Escolha o tipo de etapa que você quer adicionar, depois siga as indicações para personalizar a etapa.


Testar o fluxo de trabalho

Antes de publicar o fluxo de trabalho em um canal do seu workspace que esteja sendo ativamente usado pelos membros, você pode configurar para postar a primeira etapa em um canal de teste.

  1. Envie o POST para a URL de solicitação do seu fluxo de trabalho e acompanhe as etapas para assegurar que tudo esteja funcionando devidamente.
  2. Volte ao criador de fluxo de trabalho e atualize a primeira etapa do fluxo de trabalho para ser postada no canal da sua preferência e, em seguida, publique as alterações.