GitScrum / Docs

Vue d'ensemble

Les webhooks GitScrum envoient des notifications HTTP POST en temps réel lorsque des événements se produisent dans vos projets. Automatisez les flux de travail et intégrez avec des systèmes externes.

Les webhooks permettent à vos systèmes externes de recevoir des notifications en temps réel lorsque des événements se produisent dans les projets GitScrum. Au lieu d'interroger l'API pour détecter des changements, votre serveur reçoit une requête HTTP POST au moment où une tâche est créée, un sprint est mis à jour ou du temps est suivi.

Comment Fonctionnent les Webhooks

Les webhooks GitScrum suivent un modèle simple de publication-abonnement :

  1. Vous configurez une URL d'endpoint pour des événements spécifiques dans Paramètres du Projet → Webhooks
  2. Lorsque l'événement se produit, GitScrum envoie une requête HTTP POST à votre URL
  3. Votre serveur traite le payload et retourne un code de statut 2xx

Chaque webhook est lié à un seul projet. Vous configurez les endpoints par type d'événement, donnant un contrôle granulaire sur les notifications que vous recevez.

Événements Disponibles

GitScrum supporte 26 événements de webhook répartis en six catégories :

Événements de Tâches (7)

ÉvénementDescription
issues.storeTâche créée
issues.updateTâche mise à jour
issues.move.boardTâche déplacée entre les colonnes du board
issues.assignees.storeResponsable ajouté à la tâche
issues.assignees.destroyResponsable retiré de la tâche
issues.destroyTâche supprimée
issues.move.projectTâche déplacée vers un autre projet

Événements de Suivi du Temps (5)

ÉvénementDescription
time-tracking.issues.startTimer démarré
time-tracking.issues.stopTimer arrêté
time-tracking.issues.cancelTimer annulé
time-tracking.issues.destroyEnregistrement de temps supprimé
time-tracking.issues.storeEnregistrement de temps manuel créé

Événements de Commentaires et Médias (6)

ÉvénementDescription
comments.issues.storeCommentaire créé
comments.issues.destroyCommentaire supprimé
attachments.issues.storePièce jointe ajoutée
attachments.issues.destroyPièce jointe supprimée
videos.issues.storeVidéo ajoutée
videos.issues.destroyVidéo supprimée

Événements de User Stories (4)

ÉvénementDescription
user-stories.storeUser story créée
user-stories.updateUser story mise à jour
user-stories.voteUser story votée
user-stories.destroyUser story supprimée

Événements de Sprints (3)

ÉvénementDescription
sprints.storeSprint créé
sprints.updateSprint mis à jour
sprints.destroySprint supprimé

Autres Événements (1)

ÉvénementDescription
discussions.voteDiscussion votée

Consultez la page de chaque événement pour la référence complète du payload JSON.

Caractéristiques Principales

  • Portée par projet — Chaque webhook est configuré dans un projet spécifique
  • Livraison via HTTP POST — Tous les événements sont livrés en tant que payloads JSON via des requêtes POST
  • Envoi synchrone — Les événements sont envoyés immédiatement lorsque les actions se produisent
  • En-têtes personnalisés — Les requêtes incluent X-Header: GitScrum et User-Agent: GitScrum Webhook
  • Journal des livraisons — Chaque livraison de webhook est enregistrée avec le code de statut et la réponse

Fonctionnalité Pro

Les webhooks sont disponibles dans les plans GitScrum Pro et supérieurs. Les utilisateurs du plan gratuit peuvent voir l'interface de configuration des webhooks, mais ne peuvent pas activer les endpoints.

Prérequis

Votre endpoint de webhook doit :

  • Être accessible publiquement depuis internet
  • Accepter les requêtes HTTP POST avec un corps JSON
  • Répondre avec un code de statut 2xx dans les 30 secondes
  • Supporter HTTPS (fortement recommandé)

Prochaines Étapes