Use o Gatilho Webhook recebido para iniciar uma Automação do ClickUp quando um aplicativo externo enviar uma solicitação. Aplicativos como Stripe, GitHub ou uma integração personalizada podem enviar dados para o ClickUp e acionar sua Automação, sem precisar de nenhum conector de terceiros.
Se você quiser que uma Automação seja iniciada por um aplicativo externo, use o Gatilho Webhook recebido. Esse Gatilho inicia uma Automação padrão ou de Chat quando um aplicativo externo envia uma solicitação POST ao ClickUp. Para enviar dados para fora do ClickUp, use a Ação Chamar webhook.
O Gatilho Webhook recebido está disponível no plano Business e superiores. A disponibilidade de recursos e os limites variam conforme o plano e a função do usuário. Saiba mais
O que é o Gatilho Webhook recebido?
O Gatilho Webhook recebido permite que um aplicativo externo envie informações ao ClickUp para iniciar uma Automação.
As informações enviadas pelo aplicativo externo formam o payload. O ClickUp gera uma URL exclusiva para cada Automação que usa esse Gatilho. Quando um aplicativo envia uma solicitação POST para essa URL, a Automação é executada.
Cada URL está vinculada a uma única Automação e não expira.
Ative o ClickApp Webhook recebido
Antes que os administradores possam criar Automações com esse Gatilho, o ClickApp precisa ser ativado:
- No canto superior esquerdo, clique no nome do seu Espaço de trabalho e selecione Aplicativos.
- Pesquise e ative o Webhook recebido.
Como funciona a autenticação
O ClickUp cria uma chave de API para o seu Espaço de trabalho. Todas as URLs de webhook do Espaço de trabalho usam a mesma chave de API. Envie a chave de API no cabeçalho de autorização de cada solicitação à URL do webhook. Solicitações sem uma chave de API válida são rejeitadas.
Por padrão, apenas proprietários e administradores do Espaço de trabalho podem visualizar a chave de API.
Na seção do Gatilho, use Mostrar para ver a chave de API ou Copiar para copiá-la. Você também pode encontrar a Chave de API no cartão do ClickApp Webhook recebido e usar Mostrar ou Copiar diretamente por lá.
Crie uma Automação com o Gatilho Webhook recebido
Em um Espaço, Pasta, Subpasta, Lista ou Canal de Chat:
- No canto superior direito, clique no ícone de robô.
- Clique em Criar Automação.
- Selecione o Gatilho Webhook recebido. Uma URL de Webhook exclusiva será gerada e a chave de API do seu Espaço de trabalho será exibida.
- Clique em Copiar ao lado de URL do Webhook para copiar a URL. Clique em Copiar ao lado de Chave de API para copiar a chave.
- Em Payload de exemplo, cole um corpo JSON de exemplo. O ClickUp transforma os campos em variáveis que você pode inserir nas Ações abaixo.
- Escolha uma Ação disponível.
- Clique em Criar.
- Para executar a Automação, envie uma solicitação POST para a URL do webhook.
- Envie a chave de API como valor bruto no cabeçalho
Authorization. Uma solicitação válida retorna202. - Na seção do Gatilho, clique em Regenerar ao lado de URL do Webhook para criar uma nova URL. A URL antiga para de funcionar e retorna
404.
As solicitações recebidas têm limite de 1 MB. As solicitações são limitadas a 60 por minuto por token de API e 200 por minuto por Espaço de trabalho.
Rotacione a chave de API
Para rotacionar a chave de API do Espaço de trabalho:
- No canto superior esquerdo, clique no nome do seu Espaço de trabalho e selecione Aplicativos.
- Pesquise e selecione Webhook recebido.
- Em Chave de API, clique em Rotacionar.
- A nova chave passa a valer para todas as URLs de webhook do Espaço de trabalho. A chave antiga retorna
401para cada URL.
Atualize a chave de API em todos os aplicativos externos que enviam solicitações ao Espaço de trabalho.