> ## Documentation Index
> Fetch the complete documentation index at: https://docs.metronome.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Notifications de seuil

Les notifications de seuil surveillent des métriques en temps réel et se déclenchent lorsque des seuils définis sont franchis. Elles sont idéales pour la surveillance proactive et les workflows pilotés par l'utilisation.

Les notifications de seuil se répartissent en trois catégories principales :

* **Les notifications de seuil d'engagement et de crédit** surveillent les soldes restants des engagements ou crédits. Elles peuvent être utilisées pour notifier un client lorsqu'il a utilisé 90 % de son engagement, ou pour signaler les comptes qui sont sur le point d'épuiser leurs crédits prépayés.

<Info>
  **INFO**

  Les notifications de seuil d'engagement et de crédit alertent sur le solde des engagements et crédits au niveau du client et du contrat. [Les crédits individuels limités à un siège](https://docs.metronome.com/guides/pricing-packaging/subscription/provision-your-customer#individual-seat-credit) ne sont pas inclus dans le calcul du seuil pour ces notifications.
</Info>

* **Les notifications de seuil de dépense et d'utilisation** suivent combien un client a dépensé ou utilisé au cours d'un cycle de facturation donné. Elles peuvent être utilisées pour déclencher un message lorsqu'un client franchit un seuil de dépense, comme \$5 000, ou pour alimenter la logique d'offre de mises à niveau une fois qu'un client approche d'un certain plafond d'utilisation.
* **Les notifications de seuil de facture** surveillent les totaux des factures après que les engagements et crédits ont été appliqués aux dépenses du client. Elles peuvent être utilisées pour notifier proactivement les clients lorsque les dépenses dépassent des budgets préconfigurés.

## Types de notifications de seuil

<AccordionGroup>
  <Accordion title="Notifications d'engagement et de crédit">
    #### Solde de crédit de contrat

    **Type d'alerte :** `alerts.low_remaining_contract_credit_balance_reached`

    Se déclenche lorsque le solde de crédit d'un client atteint ou descend en dessous d'un montant défini. Si plusieurs crédits existent pour un client, Metronome additionne les soldes restants de tous les crédits pour comparer au seuil.

    Pour notifier sur un crédit spécifique, définissez un champ personnalisé sur le crédit dans Metronome et utilisez les filtres avancés pour évaluer uniquement les crédits avec cette valeur de champ personnalisé spécifique.

    #### Pourcentage de crédit de contrat

    **Type d'alerte :** `alerts.low_remaining_contract_credit_percentage_reached`

    Se déclenche si le pourcentage de crédits disponibles pour le client sur tous les crédits actifs de ce type de crédit (devise ou unité de tarification) atteint ou descend en dessous d'un seuil défini.

    Pour notifier sur un crédit spécifique, définissez un champ personnalisé sur le crédit dans Metronome et utilisez les filtres avancés pour évaluer uniquement les crédits avec cette valeur de champ personnalisé spécifique.

    #### Solde d'engagement

    **Type d'alerte :** `alerts.low_remaining_commit_balance_reached`

    Se déclenche lorsque le solde d'engagement d'un client atteint ou descend en dessous d'un montant défini. Si plusieurs engagements existent pour un client, Metronome additionne les soldes restants de tous les engagements pour comparer au seuil.

    Pour notifier sur un engagement spécifique, définissez un champ personnalisé sur l'engagement dans Metronome et utilisez les filtres avancés pour évaluer uniquement les engagements avec cette valeur de champ personnalisé spécifique.

    #### Pourcentage d'engagement

    **Type d'alerte :** `alerts.low_remaining_commit_percentage_reached`

    Se déclenche si le pourcentage d'engagements disponibles pour le client sur tous les engagements actifs de ce type de crédit (devise ou unité de tarification) atteint ou descend en dessous d'un seuil défini.

    Pour notifier sur un engagement spécifique, définissez un champ personnalisé sur l'engagement dans Metronome et utilisez les filtres avancés pour évaluer uniquement les engagements avec cette valeur de champ personnalisé spécifique.

    #### Solde de crédit et d'engagement de contrat

    **Type d'alerte :** `alerts.low_remaining_contract_credit_and_commit_balance_reached`

    Se déclenche lorsque le solde combiné d'engagement et de crédit d'un client atteint ou descend en dessous d'un montant défini. Si plusieurs engagements et crédits existent pour un client, Metronome additionne les soldes restants de tous les engagements et crédits pour comparer au seuil.

    #### Solde de sièges

    **Type d'alerte :** `alerts.low_remaining_seat_balance_reached`

    Se déclenche lorsque le solde de sièges d'un client atteint ou descend en dessous d'un montant défini. Metronome additionne les soldes restants pour le siège spécifique sur tous les engagements et crédits pour comparer au seuil.

    Utilisez le paramètre `seat_filter` requis pour limiter la notification aux soldes de sièges associés à des abonnements basés sur les sièges avec un `seat_group_key` spécifique. Metronome additionnera les soldes restants pour chaque siège sur tous les engagements et crédits pour comparer au seuil.

    Optionnellement, utilisez le paramètre `seat_filter.seat_group_value` pour limiter la notification à un siège spécifique.
  </Accordion>

  <Accordion title="Notifications de dépense et d'utilisation">
    #### Seuil de dépense

    **Type d'alerte :** `alerts.spend_threshold_reached`

    Se déclenche si les dépenses basées sur l'utilisation du client avant le tirage sur engagements et crédits pour leur période de facturation actuelle atteignent ou dépassent le seuil défini. Cette notification évalue par rapport à la somme de toutes les charges basées sur l'utilisation pour un client particulier, y compris les tirages d'utilisation sur les crédits et engagements.

    Les achats d'engagements ne sont pas pris en compte dans la notification de seuil de dépense d'un client. Par exemple, si le seuil est fixé à \$10 000, \$7 000 de charges d'utilisation plus un achat d'engagement de \$3 000 ne déclencheront pas la notification.

    De plus, les notifications de dépense sont évaluées *uniquement* par rapport aux dépenses directes dans un type de crédit spécifique. Un seuil de notification de dépense configuré pour une devise est toujours évalué à `ok` si vous utilisez une unité de tarification personnalisée pour les lignes d'articles d'un client. Pour éviter cela, configurez les seuils de notification de dépense pour utiliser la même unité de tarification que les lignes d'articles sur la facture d'un client.

    Pour notifier sur un type de contrat spécifique, définissez un champ personnalisé sur le contrat dans Metronome et utilisez les filtres avancés pour évaluer uniquement les contrats avec cette valeur de champ personnalisé spécifique.

    Optionnellement, utilisez le paramètre de filtre avancé `group_values` avec ce type de notification pour évaluer uniquement l'utilisation associée à une paire spécifique clé de groupe:valeur de groupe. Vous pouvez également filtrer sur `group_key` pour évaluer l'utilisation sur toutes les valeurs de groupe pour cette clé.

    #### Utilisation d'une métrique facturable

    **Type d'alerte :** `alerts.usage_threshold_reached`

    Se déclenche si l'utilisation par le client d'une métrique facturable particulière dans leur période de facturation actuelle atteint ou dépasse votre seuil défini.

    La période de facturation actuelle d'un client est calculée en prenant la date de début la plus précoce et la date de fin la plus tardive sur toutes les factures actives.
  </Accordion>

  <Accordion title="Notifications de facture">
    #### Total de facture

    **Type d'alerte :** `alerts.invoice_total_reached`

    Se déclenche si l'une des factures actives du client atteint ou dépasse le seuil configuré. Cette notification évalue par rapport au total net de la facture après que tous crédits, engagements ou autres ajustements ont été appliqués. Chaque facture active pour le client est évaluée séparément. De plus, seules les factures dans la devise spécifiée sont évaluées.

    Pour notifier sur un type de facture spécifique, utilisez les filtres avancés pour cibler le type de facture particulier.
  </Accordion>
</AccordionGroup>

## Exemples de charges utiles de webhook

<CodeGroup>
  ```json low_remaining_credit_balance_reached theme={null}
  {  
    "id": "445b849e-1366-4580-a6cc-f488e27c059f",  
    "properties": {  
      "customer_id": "ac39ecc3-87ee-4d58-8ec0-24041464dddd",  
      "alert_id": "445b849e-1366-4580-a6cc-f488e27c059f",  
      "timestamp": "2024-10-07T15:08:44.865Z",  
      "threshold": 20000,  
      "alert_name": "Credit balance low",  
      "credit_type_id": "2714e483-4ff1-48e4-9e25-ac732e8f24f2",  
      "remaining_balance": 5000,  
      "triggered_by": "usage"  
    },  
    "type": "alerts.low_remaining_credit_balance_reached"  
  }
  ```

  ```json spend_threshold_reached theme={null}
  {  
    "id": "7f8a9b2c-3d4e-5f6g-7h8i-9j0k1l2m3n4o",  
    "properties": {  
      "customer_id": "b2c3d4e5-f6g7-h8i9-j0k1-l2m3n4o5p6q7",  
      "alert_id": "7f8a9b2c-3d4e-5f6g-7h8i-9j0k1l2m3n4o",  
      "timestamp": "2024-10-07T16:30:15.123Z",  
      "threshold": 10000,  
      "alert_name": "Spend threshold exceeded",  
      "current_spend": 12500,  
      "triggered_by": "usage"  
    },  
    "type": "alerts.spend_threshold_reached"  
  }
  ```

  ```json low_remaining_commit_balance_reached theme={null}
  {  
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",  
    "properties": {  
      "customer_id": "c3d4e5f6-g7h8-i9j0-k1l2-m3n4o5p6q7r8",  
      "alert_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",  
      "timestamp": "2024-10-07T14:45:30.456Z",  
      "threshold": 5000,  
      "alert_name": "Commit balance low",  
      "commit_id": "d4e5f6g7-h8i9-j0k1-l2m3-n4o5p6q7r8s9",  
      "remaining_balance": 1200,  
      "triggered_by": "usage"  
    },  
    "type": "alerts.low_remaining_commit_balance_reached"  
  }
  ```

  ```json usage_threshold_reached theme={null}
  {  
    "id": "e5f6g7h8-i9j0-k1l2-m3n4-o5p6q7r8s9t0",  
    "properties": {  
      "customer_id": "f6g7h8i9-j0k1-l2m3-n4o5-p6q7r8s9t0u1",  
      "alert_id": "e5f6g7h8-i9j0-k1l2-m3n4-o5p6q7r8s9t0",  
      "timestamp": "2024-10-07T17:15:45.789Z",  
      "threshold": 1000000,  
      "alert_name": "API calls threshold exceeded",  
      "billable_metric_id": "g7h8i9j0-k1l2-m3n4-o5p6-q7r8s9t0u1v2",  
      "current_usage": 1250000,  
      "triggered_by": "usage"  
    },  
    "type": "alerts.usage_threshold_reached"  
  }
  ```

  ```json invoice_total_reached theme={null}
  {  
    "id": "h8i9j0k1-l2m3-n4o5-p6q7-r8s9t0u1v2w3",  
    "properties": {  
      "customer_id": "i9j0k1l2-m3n4-o5p6-q7r8-s9t0u1v2w3x4",  
      "alert_id": "h8i9j0k1-l2m3-n4o5-p6q7-r8s9t0u1v2w3",  
      "timestamp": "2024-10-07T18:00:00.000Z",  
      "threshold": 50000,  
      "alert_name": "Invoice total exceeded",  
      "invoice_id": "j0k1l2m3-n4o5-p6q7-r8s9-t0u1v2w3x4y5",  
      "invoice_total": 55000,  
      "triggered_by": "invoice_generation"  
    },  
    "type": "alerts.invoice_total_reached"  
  }
  ```
</CodeGroup>

## Créer et gérer les notifications de seuil

Les notifications de seuil peuvent être créées et gérées via l'interface utilisateur ou l'API. Vous pouvez définir quels seuils vous intéressent et quels clients cibler.

<Frame>
  <img src="https://mintcdn.com/metronome-b35a6a36/phb9Acjv7jlF___r/images/set-up-notification/threshold_create.png?fit=max&auto=format&n=phb9Acjv7jlF___r&q=85&s=4853446e2cd40b8c9f7bd488241e0d44" alt="Interface de création de notification de seuil affichant la configuration du seuil de dépense" width="2788" height="2188" data-path="images/set-up-notification/threshold_create.png" />
</Frame>

**Dans l'interface utilisateur**

1. Accédez à l'onglet **Notifications**
2. Cliquez sur **Créer une notification**
3. Choisissez n'importe lequel des types de notifications de seuil ci-dessus
4. Configurez les détails du seuil et le ciblage au niveau du champ personnalisé le cas échéant
5. Déterminez si vous souhaitez que la notification évalue les clients qui atteignent déjà le seuil ou ne se déclenche que sur les clients qui franchissent le seuil à l'avenir
6. Sélectionnez les clients auxquels la notification doit être appliquée
7. Cliquez sur **Enregistrer**
8. Metronome commencera à évaluer les clients sélectionnés par rapport au seuil défini et déclenchera une notification vers vos webhooks configurés lorsque le client franchira le seuil
9. Assurez-vous que vos webhooks sont configurés pour gérer correctement les charges utiles de ces notifications

**Via l'API**

1. Appelez `POST /v1/alerts/create`
2. Passez le type d'alerte, le nom et le seuil dans le corps de la requête
3. Optionnellement, passez des filtres supplémentaires pertinents au type d'alerte
4. Une réponse réussie retournera un objet CustomerAlert contenant la configuration de la notification avec son ID unique et son statut actuel

Pour obtenir le statut d'évaluation en temps réel d'une paire spécifique notification de seuil-client, vous pouvez appeler le point de terminaison `POST /v1/customer-alerts/get`. Ce point de terminaison fournit une visibilité instantanée pour savoir si un client a déclenché une condition de seuil, vous permettant de surveiller la santé du compte et de prendre des mesures proactives en fonction de l'état actuel. Ce point de terminaison est utile pour vérifier périodiquement le statut de notification de seuil d'un client, mais ne doit pas être interrogé en boucle. Vous devriez plutôt vous appuyer sur la notification webhook pour comprendre quand les clients passent à `IN_ALARM`.

Les notifications de seuil peuvent être archivées dans l'interface utilisateur ou via l'API, ce qui les retire de la surveillance active.

## Déclencheurs d'évaluation des notifications de seuil

Pour évaluer si une notification de seuil doit être envoyée, Metronome évalue régulièrement les clients ayant des notifications associées en temps réel à mesure que l'utilisation est envoyée à Metronome. Si la valeur surveillée d'un client — solde de crédit, dépense, etc. — atteint le seuil, une notification de seuil est envoyée.

Il existe deux déclencheurs possibles pour une évaluation :

* Des événements d'utilisation sont ingérés
* Les métadonnées du client changent (par exemple, un contrat est assigné ou un nouvel alias d'ingestion est assigné)

  Plus précisément, toute action CRUD (créer, lire, mettre à jour et supprimer) impactant les notifications, clients, alias d'ingestion client, contrats, engagements et crédits est considérée comme un changement de métadonnées et déclenche une évaluation de notification.

Les alertes de seuil envoient des notifications dans les minutes suivant le moment où cette condition est remplie.
