Para compartilhar dados do ClickUp com aplicativos externos, você pode usar dois tipos de Webhooks no ClickUp:
- Webhooks criados por meio da API pública do ClickUp.
- Webhooks acionados por Automações.
A disponibilidade de recursos e os limites variam conforme o plano e a função do usuário. Saiba mais
Webhooks de API
Use Webhooks de API quando quiser rastrear de forma abrangente todos os eventos de criação, atualização e exclusão de tarefas, Listas, Subpastas, Pastas, Espaços, Metas e Alvos.
Saiba mais sobre os Webhooks de API do ClickUp, incluindo:
- Consulte exemplos de payloads.
- Revise a especificação dos endpoints de webhook da API pública do ClickUp.
- Envie sua primeira requisição de criação de webhook diretamente do seu navegador.
Webhooks de Automação
Use Webhooks de Automação quando quiser controle total sobre os Gatilhos e Condições que enviam seus dados para aplicativos externos.
Há dois tipos de Webhooks de Automação que você pode criar no ClickUp:
- Webhooks de tarefa: enviam dados quando tarefas são atualizadas.
- Webhooks de Chat: enviam dados quando mensagens de chat são publicadas.
Criar um webhook
Você precisará criar um webhook para cada destino que receberá dados do ClickUp por meio de Automações.
Você pode reutilizar Webhooks criados em Automações em todo o seu Espaço de trabalho, mas precisará configurar Webhooks separados para Automações de Tarefas e de Chat.
Teste seu webhook antes de adicioná-lo a Automações que enviarão dados reais.
Usar variáveis dinâmicas no seu Webhook
Variáveis dinâmicas na URL podem ajudar seu aplicativo a processar com eficiência os dados recebidos do ClickUp.
Você pode usar variáveis dinâmicas na URL do seu webhook, como o ID da tarefa.
Usar cabeçalhos
Os cabeçalhos podem incluir metadados que permitem ao seu aplicativo processar os payloads de webhook recebidos com segurança e precisão. Por padrão, o ClickUp inclui o seguinte cabeçalho:
Content-type: application/json
Usar parâmetros de URL
Você também pode definir parâmetros de URL para cada webhook e ajudar seu aplicativo a processar os dados com precisão.
Ao contrário das variáveis dinâmicas, os parâmetros de URL são estáticos. Os valores não mudam cada vez que sua Automação é acionada.
Testar webhooks
Quando começar a usar Webhooks, recomendamos testá-los antes de enviar dados reais do seu Espaço de trabalho do ClickUp.
Você pode encontrar e usar ferramentas gratuitas online para testar e experimentar Webhooks. Por exemplo, use o webhook.site para gerar uma URL de webhook e ver os payloads enviados pelo ClickUp.
Para Webhooks de API:
- Filtre seu primeiro webhook para eventos específicos, como taskCreated e taskUpdated.
- Filtre seu primeiro webhook para um local específico, como uma Lista dedicada que contenha apenas tarefas de teste com dados genéricos, mas representativos.
Para Webhooks de Automação:
- Aplique Gatilhos e Condições precisos, como um Campo personalizado de caixa de seleção para controlar quando os dados são enviados.
- Adicione a Automação primeiro a uma Lista ou Canal específico, com tarefas e mensagens genéricas, mas representativas.