Criar uma Automação de webhook do Chat

Crie uma Automação de webhook no Chat para se comunicar com um aplicativo integrado externo quando um evento específico ocorrer no ClickUp. Por exemplo, quando uma mensagem de Chat é postada em um Canal específico, ela também é postada automaticamente no Zapier ou no Make.

Este artigo explica como enviar eventos de Chat para fora do ClickUp com a Ação Chamar webhook. Para que um aplicativo externo inicie uma Automação de Chat, use o Gatilho Webhook recebido.

Você também pode usar webhooks com Automações de tarefas.

A disponibilidade de recursos e os limites variam conforme o plano e a função do usuário. Saiba mais

Use gatilhos, ações, cabeçalhos de URL e parâmetros de Automação

Gatilhos são eventos que iniciam uma Automação.

Mensagem postada é o único gatilho de webhook de Chat.

Ações são os eventos que a Automação inicia após ser acionada. Para chamar um webhook, use a Ação Chamar webhook.

Use cabeçalhos de URL e parâmetros para definir detalhes sobre o webhook, por exemplo:

  • O local no ClickUp de onde o webhook é enviado
  • O endpoint do aplicativo externo
  • Ou o tipo de mídia do corpo da solicitação

Os cabeçalhos de URL são sensíveis. Depois de salvos, não é possível visualizar os valores do cabeçalho para editá-los.

Captura de tela de uma automação de webhook de Chat

Criar uma Automação de webhook no Chat

Para criar uma Automação de webhook no Chat, a partir de um canal:

  1. No canto superior direito, clique no ícone de robô.
  2. Clique em Criar Automação.
  3. Configure seu Gatilho, Condições e Ações:
    • Selecione a Ação Chamar webhook.
    • Selecione um webhook existente ou Criar webhook:
    • Dê um nome e uma descrição opcional ao seu webhook.
    • Insira a URL do seu webhook.
    • Selecione os campos dinâmicos a seguir para incluí-los na URL.
    • ID do comentário: adicione o ID do comentário de Chat individual.
    • ID do canal: adicione o ID do Canal de Chat.
    • Adicione cabeçalhos personalizados opcionais:
    • Clique em Adicionar e insira uma chave e um valor.
    • Por padrão, os cabeçalhos de webhook incluem Content-type=application/json.
    • Adicione parâmetros de URL personalizados opcionais:
    • Insira uma chave e um valor para adicionar parâmetros de URL personalizados.
    • Clique em Adicionar para incluir mais pares de chave e valor.
  4. Clique em Criar webhook.

Testar uma Automação de webhook no Chat

Após criar o webhook, você pode testá-lo no ClickUp.

Para testar uma Automação de webhook no Chat:

  1. Logo após criar o webhook, no canto superior esquerdo do modal de Automação, clique na seta. Ou, a partir de um canal:
    • Clique no ícone de robô.
    • Selecione Gerenciar Automações de Chat.
    • Clique na aba Webhooks.
  2. Passe o cursor sobre o webhook e clique em Testar.
    • Uma mensagem indica sucesso ou falha.

Se o teste falhar

Verifique se o aplicativo externo está em funcionamento. Se estiver fora do ar, podemos bloquear a chamada do webhook por motivos de segurança.

Se o teste for bem-sucedido

Se o teste for bem-sucedido, você pode ativar o webhook de Chat em uma Automação.

Criar uma Automação de Chat com um webhook existente

Após testar o webhook de Chat, você o ativará no seu Espaço de trabalho.

Para ativar o webhook de Chat:

  1. Logo após testar o webhook, no modal de Automações, selecione a aba Gerenciar.
  2. Clique em Adicionar Automação.
  3. Configure seu Gatilho, Condições e Ações:
    • Selecione a Ação Chamar webhook.
    • Selecione seu webhook.
  4. Clique em Criar.

Falha na chamada do webhook

Se o seu webhook estiver ativo e uma chamada falhar inicialmente, tentamos novamente por 1 hora e 15 minutos. Durante esse período, a chamada aparece na aba Atividade de Automações com status pendente.

Desativar o webhook de Chat

Após o webhook de Chat ser ativado, você pode torná-lo inativo.

Para desativar o webhook de Chat, a partir de um canal:

  1. No canto superior direito, clique no ícone de robô.
  2. Selecione Gerenciar Automações de Chat.
  3. Clique na aba Webhooks.
  4. À direita do seu webhook, clique no botão de alternância para desativá-lo.
  5. Leia o aviso informando que as Automações que usam o webhook também serão desativadas.
  6. Clique em Desativar.
  7. O webhook de Chat agora aparece na aba Inativo.

Para reativar o webhook de Chat, abra a aba Inativo e clique no botão de alternância para ativá-lo.

Captura de tela da aba de webhooks, destacando a opção de desativar um webhook.

Chaves e valores de cabeçalho

Veja a seguir os cabeçalhos disponíveis e algumas diretrizes para criar cabeçalhos personalizados:

Chave do cabeçalho Descrição Valor do cabeçalho
Accept Especifica o tipo de resposta que o servidor enviará. application/json, text/html
Authorization Envia as credenciais do cliente no corpo da solicitação.
Por exemplo, um JSON Web Token.
abC0012.Efg34.hIj5
Content-type Apenas JSON é suportado. application/json
Referrer Contém a URL completa ou parcial onde os recursos solicitados estão armazenados. http:www.example.com
Custom Cabeçalhos personalizados são usados para proteger o payload, por exemplo, especificando uma chave de autorização. Insira uma chave e um valor personalizados.