Types de notifications système
DIFFÉRENCES DE SCHÉMA DE CHARGE UTILELe schéma des charges utiles pour les notifications système diffère légèrement de celui des notifications de seuil. Plus précisément, la charge utile des notifications système n’inclut pas de champ
properties. Assurez-vous que vos webhooks sont correctement configurés pour gérer les deux types de notifications.| Type | Nom | Détails |
|---|---|---|
| Contrat | contract.create | Se déclenche lorsqu’un nouveau contrat est créé |
| Contrat | contract.start | Se déclenche lorsqu’un contrat commence |
| Contrat | contract.edit | Se déclenche lorsqu’un contrat est modifié |
| Contrat | contract.end | Se déclenche lorsqu’un contrat se termine |
| Contrat | contract.archive | Se déclenche lorsqu’un contrat est archivé |
| Engagement et crédit | commit.create | Se déclenche lorsqu’un nouvel engagement est créé |
| Engagement et crédit | commit.edit | Se déclenche lorsqu’un engagement est modifié |
| Engagement et crédit | commit.archive | Se déclenche lorsqu’un engagement est archivé |
| Engagement et crédit | commit.segment.start | Se déclenche lorsqu’un segment d’engagement commence Le numéro de segment qui a déclenché la notification et le nombre total de segments d’engagement se trouvent dans la charge utile |
| Engagement et crédit | commit.segment.end | Se déclenche lorsqu’un segment d’engagement se termine Le numéro de segment qui a déclenché la notification et le nombre total de segments d’engagement se trouvent dans la charge utile |
| Engagement et crédit | credit.create | Se déclenche lorsqu’un nouveau crédit est créé |
| Engagement et crédit | credit.edit | Se déclenche lorsqu’un crédit est modifié |
| Engagement et crédit | credit.archive | Se déclenche lorsqu’un crédit est archivé |
| Engagement et crédit | credit.segment.start | Se déclenche lorsqu’un segment de crédit commence Le numéro de segment qui a déclenché la notification et le nombre total de segments de crédit se trouvent dans la charge utile |
| Engagement et crédit | credit.segment.end | Se déclenche lorsqu’un segment de crédit se termine Le numéro de segment qui a déclenché la notification et le nombre total de segments de crédit se trouvent dans la charge utile |
Exemples de charges utiles de webhook
Activer et gérer les notifications système
Les notifications système peuvent être activées et gérées via l’interface utilisateur ou l’API.
- Accédez à l’onglet Notifications
- Trouvez la notification système que vous souhaitez activer. Toutes les notifications système disponibles apparaîtront dans la vue liste des notifications et seront désactivées par défaut pour tout compte
- Cliquez sur la notification
- Cliquez sur le bouton à côté de Statut pour activer
- Confirmez l’action pour activer
- Vous commencerez à recevoir des notifications sur cet événement système pour tous les clients vers tous les webhooks configurés
- Assurez-vous que vos webhooks sont configurés pour gérer correctement les charges utiles de ces notifications
- Appelez
POST /v2/notifications/edit - Passez la politique de la notification système que vous souhaitez activer (par exemple,
contract.create) etis_enableddéfini sur true - Une réponse réussie retournera un code de réponse 200
LIMITATION DES DONNÉES HISTORIQUESLorsque vous activez une notification système, Metronome commence à générer des événements à partir de ce moment-là. Il ne revient pas en arrière pour créer des événements pour les données passées. De plus, la politique des notifications système ne peut pas être modifiée.