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 :
- Vous configurez une URL d'endpoint pour des événements spécifiques dans Paramètres du Projet → Webhooks
- Lorsque l'événement se produit, GitScrum envoie une requête HTTP POST à votre URL
- 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énement | Description |
|---|---|
issues.store | Tâche créée |
issues.update | Tâche mise à jour |
issues.move.board | Tâche déplacée entre les colonnes du board |
issues.assignees.store | Responsable ajouté à la tâche |
issues.assignees.destroy | Responsable retiré de la tâche |
issues.destroy | Tâche supprimée |
issues.move.project | Tâche déplacée vers un autre projet |
Événements de Suivi du Temps (5)
| Événement | Description |
|---|---|
time-tracking.issues.start | Timer démarré |
time-tracking.issues.stop | Timer arrêté |
time-tracking.issues.cancel | Timer annulé |
time-tracking.issues.destroy | Enregistrement de temps supprimé |
time-tracking.issues.store | Enregistrement de temps manuel créé |
Événements de Commentaires et Médias (6)
| Événement | Description |
|---|---|
comments.issues.store | Commentaire créé |
comments.issues.destroy | Commentaire supprimé |
attachments.issues.store | Pièce jointe ajoutée |
attachments.issues.destroy | Pièce jointe supprimée |
videos.issues.store | Vidéo ajoutée |
videos.issues.destroy | Vidéo supprimée |
Événements de User Stories (4)
| Événement | Description |
|---|---|
user-stories.store | User story créée |
user-stories.update | User story mise à jour |
user-stories.vote | User story votée |
user-stories.destroy | User story supprimée |
Événements de Sprints (3)
| Événement | Description |
|---|---|
sprints.store | Sprint créé |
sprints.update | Sprint mis à jour |
sprints.destroy | Sprint supprimé |
Autres Événements (1)
| Événement | Description |
|---|---|
discussions.vote | Discussion 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: GitScrumetUser-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
- Démarrage Rapide — Configurez votre premier webhook en 5 minutes
- Configurer les Endpoints — Configurez les endpoints dans l'interface GitScrum
- Tâche Créée — Voir un exemple complet de payload
- Format du Payload — Comprendre la structure du payload JSON
- Sécurité — En-têtes, HTTPS et considérations de sécurité