GitScrum / Docs

Inicio Rápido

Configura tu primer webhook de GitScrum en 5 minutos. Recibe notificaciones de tareas en tiempo real en tu servidor con un endpoint simple.

Configura un endpoint de webhook y comienza a recibir eventos en tiempo real de GitScrum en 5 minutos.

Prerrequisitos

  • Una cuenta GitScrum en plan Pro o superior
  • Un proyecto con permisos de Manager o Owner
  • Un servidor accesible públicamente para recibir solicitudes HTTP POST

Paso 1: Crear un Endpoint Receptor

Configura un endpoint HTTP simple que acepte solicitudes POST. Aquí hay un ejemplo usando Node.js con 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');
});

O usando Python con 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)

Paso 2: Configurar el Webhook en GitScrum

  1. Abre tu proyecto en GitScrum
  2. Navega a Configuración del Proyecto → pestaña Webhooks
  3. Expande la categoría Tasks
  4. En la fila Task Created (issues.store), ingresa la URL de tu endpoint: https://your-server.com/webhooks/gitscrum
  5. Presiona Enter o haz clic fuera del campo para guardar
  6. El indicador de estado se pone verde cuando se guarda

Paso 3: Probar el Webhook

  1. Haz clic en el ícono de prueba (ícono de pulso) junto al endpoint configurado
  2. GitScrum envía un payload de prueba a tu URL
  3. Verifica los logs de tu servidor para la solicitud recibida
  4. Un mensaje de éxito aparece en la interfaz si tu servidor responde con 2xx

Paso 4: Disparar un Evento Real

  1. Ve al board Kanban de tu proyecto
  2. Crea una nueva tarea
  3. Tu endpoint de webhook recibe un HTTP POST con los datos completos de la tarea

Lo Que Recibes

Cuando se crea una tarea, tu endpoint recibe un 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 Pasos