Testar grátis

Webhooks do Projeto

A aba Webhooks permite configurar endpoints HTTP para receber notificações em tempo real quando eventos específicos ocorrem no seu projeto. Sistemas externos recebem requisições POST instantâneas em vez de consultar a API, habilitando workflows automatizados e integrações com aplicações personalizadas.

Visão Geral

A interface exibe uma tabela de eventos de webhook pré-definidos organizados por categoria. Cada evento possui um campo de URL de endpoint onde você insere o endereço do seu servidor receptor. Quando um evento ocorre, o GitScrum envia uma requisição HTTP POST para a URL configurada com os dados do evento.

O cabeçalho mostra estatísticas incluindo o número total de webhooks carregados e quantos estão atualmente ativos (têm URL configurada).

Categorias de Webhook

Os eventos são agrupados em categorias expansíveis. Clique no cabeçalho de uma categoria para expandir ou recolher seus eventos.

Tasks

Webhooks para eventos relacionados a tarefas:

  • Tarefa Criada (issues.store) - Disparado quando uma nova tarefa é criada
  • Tarefa Atualizada (issues.update) - Disparado quando campos da tarefa são modificados
  • Tarefa Movida no Board (issues.move.board) - Disparado quando uma tarefa muda de estágio do workflow
  • Responsáveis Alterados (issues.assignees) - Disparado quando atribuições da tarefa mudam
  • Tarefa Excluída (issues.destroy) - Disparado quando uma tarefa é removida
  • Tarefa Movida para Projeto (issues.move.project) - Disparado quando uma tarefa é transferida para outro projeto
  • Time Tracking (time-tracking) - Disparado quando tempo é registrado em uma tarefa

User Stories

Webhooks para eventos de user stories:

  • Eventos de User Story (user-stories) - Disparado quando user stories são criadas, atualizadas ou excluídas

Sprints

Webhooks para eventos de sprint:

  • Eventos de Sprint (sprints) - Disparado quando sprints são criados, iniciados, concluídos ou modificados

Outros

Webhooks para eventos adicionais do projeto:

  • Discussões (discussions) - Disparado quando discussões são criadas ou atualizadas
  • Comentários (comments) - Disparado quando comentários são adicionados a tarefas
  • Anexos (attachments) - Disparado quando arquivos são anexados
  • Vídeos (videos) - Disparado quando vídeos são adicionados

Configurando um Webhook

  1. Expanda a categoria contendo o evento que você deseja configurar
  2. Localize a linha do evento na tabela
  3. Insira a URL do seu endpoint no campo de entrada
  4. Pressione Enter ou clique fora do campo para salvar
  5. O indicador de status fica verde quando salvo com sucesso

A URL do endpoint deve ser uma URL HTTP ou HTTPS válida. HTTPS é recomendado por segurança.

Indicadores de Status de Webhook

Cada webhook exibe um indicador de status:

  • Ponto verde - Webhook está ativo com endpoint configurado
  • Ponto cinza - Webhook não possui endpoint configurado

O cabeçalho da categoria mostra uma contagem de webhooks ativos dentro daquela categoria (ex: "2/7" significa 2 de 7 webhooks têm URLs configuradas).

Testando Webhooks

Testar Webhook Individual

  1. Configure uma URL de endpoint para o webhook
  2. Clique no botão de ícone de teste (ícone de pulso) na coluna Ações
  3. Um payload de teste é enviado para seu endpoint
  4. Mensagem de sucesso ou erro aparece abaixo do campo de entrada

Testar Todos os Webhooks

Clique no botão Testar Todos no cabeçalho para enviar requisições de teste para todos os webhooks configurados simultaneamente. Isso é útil para verificar toda a sua configuração de webhooks de uma vez.

Removendo um Webhook

  1. Clique no ícone X na coluna Ações
  2. A URL do endpoint é limpa
  3. O indicador de status fica cinza
  4. Nenhum evento adicional é enviado para aquele endpoint

Requisitos do Endpoint

Seu endpoint de webhook deve:

  • Aceitar requisições HTTP POST
  • Retornar código de status 2xx dentro de 30 segundos
  • Ser publicamente acessível dos servidores do GitScrum
  • Lidar com possíveis retentativas graciosamente

Boas Práticas

A seção de informações na parte inferior da página exibe recomendações chave:

  • Use HTTPS - Criptografe dados de webhook em trânsito
  • Retorne status 2xx - Confirme o recebimento imediatamente
  • Lide com retentativas - O mesmo evento pode ser entregue múltiplas vezes

Exemplos de Integração

Automação Personalizada: Configure webhooks para disparar seus sistemas internos quando tarefas mudam de status, habilitando workflows personalizados.

Dashboards Externos: Envie eventos de tarefas e sprints para atualizar dashboards em tempo real fora do GitScrum.

Sistemas de Notificação: Direcione eventos para sua própria infraestrutura de notificações para alertas personalizados.

Ferramentas de Workflow: Use URLs de webhook de plataformas de automação como Zapier, Make ou n8n para disparar workflows de múltiplas etapas.

Recursos Relacionados

  • Acesso à API - Gere tokens de API para acesso programático
  • Integrações - Integrações pré-construídas com Slack, Discord, Teams e provedores Git