Crie uma Automação de webhook para se comunicar com um aplicativo integrado externo quando um evento específico ocorrer em uma tarefa do ClickUp.
Confira nosso artigo Criar uma Automação de webhook de Chat para aprender sobre nossos webhooks de Chat
A disponibilidade e os limites de recursos variam de acordo com o plano e o papel do usuário. Saiba mais
O que são webhooks?
Webhooks são uma maneira automatizada de enviar informações do ClickUp para suas integrações e outros sistemas.
Em vez de solicitar as informações do ClickUp, os webhooks enviam informações proativamente para manter os dados em outros sistemas atualizados.
As informações enviadas do ClickUp quando um webhook é acionado, ou chamado, são conhecidas como payload.
Para webhooks de tarefa, o payload inclui informações sobre a tarefa que acionou a Automação no ClickUp.
Você também pode configurar webhooks usando nossa API pública.
Ações de Chamar webhook
De uma Lista, Pasta ou Espaço no ClickUp, você pode criar uma Automação acionada pela atividade da tarefa que chama um webhook como uma Ação de Automação.
A tabela a seguir descreve as Ações disponíveis:
| Ação | Descrição | Exemplo de payload |
| Chamar webhook | O ClickUp envia informações sobre a tarefa de acionamento. | Exemplo de payload |
| Chamar webhook (Legado) | O ClickUp envia informações sobre a tarefa de acionamento. | Exemplo de payload |
Cada ação tem um payload diferente. Recomendamos usar a Ação Chamar webhook para quaisquer novas integrações que você esteja construindo.
Use cabeçalhos e parâmetros de URL
Use cabeçalhos e parâmetros de URL para definir detalhes sobre o webhook, por exemplo:
- A localização do 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. Uma vez salvos, você não pode visualizar os valores dos cabeçalhos para editá-los.
A seguir estão os cabeçalhos que fornecemos e algumas diretrizes sobre como criar cabeçalhos personalizados:
| Chave do Cabeçalho | Descrição | Valor do Cabeçalho |
| Accept | Especifica o tipo de resposta que o servidor irá enviar. | application/json, text/html |
| Authorization |
Envia as credenciais do cliente no corpo da solicitação. Por exemplo, um Token Web JSON. |
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 valor personalizados. |
Crie um webhook sem criar uma Automação
Para criar um webhook antes de configurar uma Automação, de uma Lista, Pasta ou Espaço:
- Clique no botão Automatizar ou no ícone de raio.
- Clique em Gerenciar Automations.
- Clique na aba Webhooks.
- Clique em Criar webhook.
- Insira um título único.
- Adicione uma descrição.
- Insira sua URL de webhook.
- Selecione quaisquer campos dinâmicos para incluí-los na URL.
- Adicione cabeçalhos personalizados:
- Por padrão, os cabeçalhos do webhook incluem
Content-type=application/json. - Clique em Adicionar para adicionar mais pares de chave e valor.
- Por padrão, os cabeçalhos do webhook incluem
- Adicione parâmetros de URL personalizados opcionais:
- Insira uma chave e valor para adicionar parâmetros de URL personalizados.
- Clique em Adicionar para adicionar mais pares de chave e valor.
- Clique em Testar webhook para enviar um exemplo de payload.
- Clique em Criar webhook.
Use um webhook existente em uma Automação
Para criar uma Automação usando um webhook existente, de uma Lista, Pasta ou Espaço:
- Clique no botão Automatizar ou no ícone de raio.
- Clique em Criar Automação.
- Selecione a Ação Chamar webhook.
- Selecione seu webhook no menu suspenso.
- Clique em Criar.
Crie um webhook usando a ação Chamar webhook
Para criar um webhook enquanto cria uma Automação, de uma Lista, Pasta ou Espaço:
- Clique no botão Automatizar ou no ícone de raio.
- Clique em Criar Automação.
- Selecione a Ação Chamar webhook.
- Clique em Criar Webhook.
- Insira um título único.
- Adicione uma descrição.
- Insira sua URL de webhook.
- Selecione quaisquer campos dinâmicos para incluí-los na URL.
- Na seção Cabeçalhos, por padrão, o tipo de conteúdo é definido como application/json.
- Para adicionar um cabeçalho personalizado, clique em +Adicionar e insira uma chave e um valor.
- Na seção Parâmetros de URL, insira uma chave e um valor para adicionar parâmetros personalizados.
- Clique em Testar webhook para enviar um exemplo de payload antes de ativar seu webhook.
- Clique em Criar webhook.
- Finalize a configuração do seu Gatilho de Automação, Condições e quaisquer outras Ações.
- Clique em Criar.
Teste seu webhook
Após criar um webhook, você pode testá-lo, editá-lo, excluí-lo ou desativá-lo na aba Webhooks:
- Passe o mouse sobre o webhook e clique em Testar.
- Uma mensagem será exibida informando sucesso ou falha.
Se o teste falhar
Se o teste falhar, verifique se o aplicativo externo está operacional. 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 com confiança e começar a usá-lo em Automations!
Chamada de webhook falhada
Se o seu webhook estiver ativo e uma chamada de webhook falhar inicialmente, nós tentamos novamente por 1 hora e 15 minutos. Durante esse tempo, a chamada será exibida na sua aba de Atividade de Automations com status pendente.
Desativar o webhook
Após um webhook de tarefa ser ativado, você pode torná-lo inativo.
Na aba de webhooks, clique no botão para tornar um webhook existente inativo.
Qualquer Automação que utilize o webhook também será tornada inativa.
Use a Ação Chamar webhook (Legado)
Para usar a Ação Chamar webhook (Legado), de uma Lista, Pasta ou Espaço:
- Clique no botão Automatizar ou no ícone de raio.
- Clique em Criar Automação.
- Selecione a Ação Chamar webhook (Legado).
- Insira sua URL de webhook.
- Selecione quaisquer campos dinâmicos para incluí-los na URL.
- Clique em Criar.
Ficou com alguma dúvida? Acione o suporte oficial a qualquer momento.
Para soluções completas de implantação, treinamento ou licenciamento no Brasil, conte com a Audatia, parceira oficial do ClickUp. Descubra como podemos ajudar →
