GitScrum / Docs

Início Rápido

Configure seu primeiro webhook do GitScrum em 5 minutos. Receba notificações de tarefas em tempo real no seu servidor com um endpoint simples.

Configure um endpoint de webhook e comece a receber eventos em tempo real do GitScrum em 5 minutos.

Pré-requisitos

  • Uma conta GitScrum no plano Pro ou superior
  • Um projeto com permissões de Manager ou Owner
  • Um servidor publicamente acessível para receber requisições HTTP POST

Passo 1: Criar um Endpoint Receptor

Configure um endpoint HTTP simples que aceite requisições POST. Aqui está um exemplo usando Node.js com Express:

const express = require('express');
const app = express();

app.use(express.json());

app.post('/webhooks/gitscrum', (req, res) => {
  const event = req.body;

  console.log('Received webhook:', JSON.stringify(event, null, 2));

  // Process the event based on type
  // Your business logic here

  res.status(200).json({ received: true });
});

app.listen(3000, () => {
  console.log('Webhook receiver listening on port 3000');
});

Ou usando Python com Flask:

from flask import Flask, request, jsonify

app = Flask(__name__)

@app.route('/webhooks/gitscrum', methods=['POST'])
def webhook():
    event = request.get_json()

    print(f"Received webhook: {event}")

    # Process the event
    # Your business logic here

    return jsonify({"received": True}), 200

if __name__ == '__main__':
    app.run(port=3000)

Passo 2: Configurar o Webhook no GitScrum

  1. Abra seu projeto no GitScrum
  2. Navegue para Configurações do Projeto → aba Webhooks
  3. Expanda a categoria Tasks
  4. Na linha Task Created (issues.store), insira a URL do seu endpoint: https://your-server.com/webhooks/gitscrum
  5. Pressione Enter ou clique fora do campo para salvar
  6. O indicador de status fica verde quando salvo

Passo 3: Testar o Webhook

  1. Clique no ícone de teste (ícone de pulso) ao lado do endpoint configurado
  2. O GitScrum envia um payload de teste para sua URL
  3. Verifique os logs do seu servidor para a requisição recebida
  4. Uma mensagem de sucesso aparece na interface se seu servidor responder com 2xx

Passo 4: Disparar um Evento Real

  1. Vá para o board Kanban do seu projeto
  2. Crie uma nova tarefa
  3. Seu endpoint de webhook recebe um HTTP POST com os dados completos da tarefa

O Que Você Recebe

Quando uma tarefa é criada, seu endpoint recebe um payload JSON como este:

{
  "data": {
    "uuid": "abc123-def456",
    "title": "Implement login page",
    "type": {
      "title": "Feature"
    },
    "workflow": {
      "title": "To Do",
      "color": "#6B7280"
    },
    "priority": {
      "title": "Medium",
      "color": "#F59E0B"
    },
    "created_at": {
      "date_for_humans": "2 minutes ago",
      "timezone": "UTC"
    }
  }
}

Próximos Passos