GitScrum / Docs

Démarrage Rapide

Configurez votre premier webhook GitScrum en 5 minutes. Recevez des notifications de tâches en temps réel sur votre serveur avec un endpoint simple.

Configurez un endpoint de webhook et commencez à recevoir des événements en temps réel de GitScrum en 5 minutes.

Prérequis

  • Un compte GitScrum avec le plan Pro ou supérieur
  • Un projet avec les permissions Manager ou Owner
  • Un serveur accessible publiquement pour recevoir les requêtes HTTP POST

Étape 1 : Créer un Endpoint Récepteur

Configurez un endpoint HTTP simple qui accepte les requêtes POST. Voici un exemple utilisant Node.js avec 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 en utilisant Python avec 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)

Étape 2 : Configurer le Webhook dans GitScrum

  1. Ouvrez votre projet dans GitScrum
  2. Naviguez vers Project Settings → onglet Webhooks
  3. Développez la catégorie Tasks
  4. Dans la ligne Task Created (issues.store), entrez l'URL de votre endpoint : https://your-server.com/webhooks/gitscrum
  5. Appuyez sur Entrée ou cliquez en dehors du champ pour sauvegarder
  6. L'indicateur de statut devient vert lorsque c'est sauvegardé

Étape 3 : Tester le Webhook

  1. Cliquez sur l'icône de test (icône de pouls) à côté de l'endpoint configuré
  2. GitScrum envoie un payload de test à votre URL
  3. Vérifiez les logs de votre serveur pour la requête reçue
  4. Un message de succès apparaît dans l'interface si votre serveur répond avec 2xx

Étape 4 : Déclencher un Événement Réel

  1. Allez sur le board Kanban de votre projet
  2. Créez une nouvelle tâche
  3. Votre endpoint de webhook reçoit un HTTP POST avec les données complètes de la tâche

Ce Que Vous Recevez

Lorsqu'une tâche est créée, votre endpoint reçoit un payload JSON comme celui-ci :

{
  "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"
    }
  }
}

Prochaines Étapes