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.

Este artigo aborda o envio de dados pelo ClickUp com a Ação Chamar webhook. Para que um aplicativo externo inicie uma Automação no ClickUp, use o Webhook recebido como Gatilho.

Confira nosso artigo Criar uma Automação de webhook do Chat para saber mais sobre os webhooks do Chat.

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

O que são webhooks?

Webhooks são uma forma automatizada de enviar informações do ClickUp para suas integrações e outros sistemas.

Em vez de buscar as informações no ClickUp, os webhooks enviam informações de forma proativa para manter os dados de outros sistemas atualizados.

As informações enviadas pelo ClickUp quando um webhook é acionado, ou chamado, são conhecidas como payload.

Para webhooks de tarefas, 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

Em um Espaço, Pasta, Subpasta ou Lista no ClickUp, você pode criar uma Automação acionada por atividade de tarefa que chama um webhook como Ação de Automação.

A tabela a seguir descreve as Ações disponíveis:

Cada ação tem um payload diferente. Recomendamos usar a ação Chamar webhook para qualquer nova integração que você estiver criando.

Usar cabeçalhos e parâmetros de URL

Use cabeçalhos e parâmetros de URL 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 dos cabeçalhos para editá-los.

Veja a seguir os cabeçalhos que disponibilizamos e algumas diretrizes para criar cabeçalhos personalizados:

Criar um webhook sem criar uma Automação

Para criar um webhook antes de configurar uma Automação, em um Espaço, Pasta, Subpasta ou Lista:

1. No canto superior direito, clique no ícone de robô.
2. Clique em Gerenciar Automações.
3. Clique na aba Webhooks.
4. Clique em Criar webhook.
5. Insira um título exclusivo.
6. Adicione uma descrição.
7. Insira a URL do seu webhook.
8. Selecione os campos dinâmicos que deseja incluir na URL.
9. Adicione cabeçalhos personalizados:
   • Por padrão, os cabeçalhos do webhook incluem Content-type=application/json.
   • Clique em Adicionar para incluir mais pares de chave e valor.
10. 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.
11. Clique em Testar webhook para enviar um exemplo de payload.
12. Clique em Criar webhook.

Usar um webhook existente em uma Automação

Para criar uma Automação usando um webhook existente, em um Espaço, Pasta, Subpasta ou Lista:

1. No canto superior direito, clique no ícone de robô.
2. Clique em Criar Automação.
3. Selecione a Ação Chamar webhook.
4. Selecione seu webhook no menu suspenso.
5. Clique em Criar.

Criar um webhook usando a ação Chamar webhook

Para criar um webhook enquanto configura uma Automação, em um Espaço, Pasta, Subpasta ou Lista:

1. No canto superior direito, clique no ícone de robô.
2. Clique em Criar Automação.
3. Selecione a Ação Chamar webhook.
4. Clique em Criar Webhook.
5. Insira um título exclusivo.
6. Adicione uma descrição.
7. Insira a URL do seu webhook.
8. Selecione os campos dinâmicos que deseja incluir na URL.
9. Na seção Cabeçalhos, o tipo de conteúdo está definido como application/json por padrão.
   • Para adicionar um cabeçalho personalizado, clique em +Adicionar e insira uma chave e um valor.
10. Na seção Parâmetros de URL, insira uma chave e um valor para adicionar parâmetros personalizados.
11. Clique em Testar webhook para enviar um exemplo de payload antes de ativar seu webhook.
12. Clique em Criar webhook.
13. Conclua a configuração do Gatilho, das Condições e de quaisquer outras Ações da sua Automação.
14. Clique em Criar.

Testar seu webhook

Após criar um webhook, você pode testá-lo, editá-lo, excluí-lo ou desativá-lo na aba Webhooks:

1. Passe o cursor sobre o webhook e clique em Testar.
2. Uma mensagem é exibida indicando êxito ou falha.

Se o teste falhar

Se o teste falhar, verifique se o aplicativo externo está funcionando. Se ele 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 Automações!

Falha na chamada do webhook

Se seu webhook estiver ativo e uma chamada falhar, fazemos novas tentativas 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

Após ativar um webhook de tarefa, você pode torná-lo inativo.

Na aba de webhooks, clique no botão de alternância para desativar um webhook existente.

Todas as Automações que usam o webhook também serão desativadas.

Usar a Ação Chamar webhook (Legado)

Para usar a Ação Chamar webhook (Legado), em um Espaço, Pasta, Subpasta ou Lista:

1. No canto superior direito, clique no ícone de robô.
2. Clique em Criar Automação.
3. Selecione a Ação Chamar webhook (Legado).
4. Insira a URL do seu webhook.
5. Selecione os campos dinâmicos que deseja incluir na URL.
6. Clique em Criar.