Visão Geral
Os webhooks do GitScrum enviam notificações HTTP POST em tempo real quando eventos ocorrem nos seus projetos. Automatize fluxos de trabalho e integre com sistemas externos.
Os webhooks permitem que seus sistemas externos recebam notificações em tempo real quando eventos acontecem dentro dos projetos GitScrum. Em vez de consultar a API por mudanças, seu servidor recebe uma requisição HTTP POST no momento em que uma tarefa é criada, um sprint é atualizado ou o tempo é rastreado.
Como os Webhooks Funcionam
Os webhooks do GitScrum seguem um modelo simples de publicação-assinatura:
- Você configura uma URL de endpoint para eventos específicos em Configurações do Projeto → Webhooks
- Quando o evento ocorre, o GitScrum envia uma requisição HTTP POST para sua URL
- Seu servidor processa o payload e retorna um código de status 2xx
Cada webhook é vinculado a um único projeto. Você configura endpoints por tipo de evento, dando controle granular sobre quais notificações recebe.
Eventos Disponíveis
O GitScrum suporta 26 eventos de webhook em seis categorias:
Eventos de Tarefas (7)
| Evento | Descrição |
|---|---|
issues.store | Tarefa criada |
issues.update | Tarefa atualizada |
issues.move.board | Tarefa movida entre colunas do board |
issues.assignees.store | Responsável adicionado à tarefa |
issues.assignees.destroy | Responsável removido da tarefa |
issues.destroy | Tarefa excluída |
issues.move.project | Tarefa movida para outro projeto |
Eventos de Controle de Tempo (5)
| Evento | Descrição |
|---|---|
time-tracking.issues.start | Timer iniciado |
time-tracking.issues.stop | Timer parado |
time-tracking.issues.cancel | Timer cancelado |
time-tracking.issues.destroy | Registro de tempo excluído |
time-tracking.issues.store | Registro de tempo manual criado |
Eventos de Comentários e Mídia (6)
| Evento | Descrição |
|---|---|
comments.issues.store | Comentário criado |
comments.issues.destroy | Comentário excluído |
attachments.issues.store | Anexo adicionado |
attachments.issues.destroy | Anexo removido |
videos.issues.store | Vídeo adicionado |
videos.issues.destroy | Vídeo removido |
Eventos de User Stories (4)
| Evento | Descrição |
|---|---|
user-stories.store | User story criada |
user-stories.update | User story atualizada |
user-stories.vote | User story votada |
user-stories.destroy | User story excluída |
Eventos de Sprints (3)
| Evento | Descrição |
|---|---|
sprints.store | Sprint criado |
sprints.update | Sprint atualizado |
sprints.destroy | Sprint excluído |
Outros Eventos (1)
| Evento | Descrição |
|---|---|
discussions.vote | Discussão votada |
Consulte a página de cada evento para a referência completa do payload JSON.
Características Principais
- Escopo por projeto — Cada webhook é configurado dentro de um projeto específico
- Entrega via HTTP POST — Todos os eventos são entregues como payloads JSON via requisições POST
- Envio síncrono — Os eventos são enviados imediatamente quando as ações ocorrem
- Cabeçalhos personalizados — As requisições incluem
X-Header: GitScrumeUser-Agent: GitScrum Webhook - Log de entregas — Cada entrega de webhook é registrada com código de status e resposta
Recurso Pro
Os webhooks estão disponíveis nos planos GitScrum Pro e superiores. Usuários do plano gratuito podem visualizar a interface de configuração de webhooks, mas não podem ativar endpoints.
Requisitos
Seu endpoint de webhook deve:
- Ser acessível publicamente pela internet
- Aceitar requisições HTTP POST com corpo JSON
- Responder com um código de status 2xx dentro de 30 segundos
- Suportar HTTPS (fortemente recomendado)
Próximos Passos
- Início Rápido — Configure seu primeiro webhook em 5 minutos
- Configurar Endpoints — Configure endpoints na interface do GitScrum
- Tarefa Criada — Veja um exemplo completo de payload
- Formato do Payload — Entenda a estrutura do payload JSON
- Segurança — Cabeçalhos, HTTPS e considerações de segurança