Notifications système

Les notifications système surveillent le moment où des événements ou actions se produisent en fonction de l’horodatage configuré d’un objet (par exemple, le début d’un contrat) ou du moment où une action s’est produite (par exemple, contrat créé). Elles sont idéales pour les workflows d’automatisation basés sur le temps autour des événements clés du cycle de vie d’un client.

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

{
  "id": "fca7b4ef-6187-51d5-a9d9-b57f40117728",
  "type": "contract.create",
  "timestamp": "2025-09-12T20:20:04Z",
  "environment_type": "PRODUCTION",
  "contract_id": "33d206f6-7455-49f6-857d-2172c37db68d",
  "contract_custom_fields": {
    "org_key": "g_major"
  },
  "customer_id": "1ed86915-97f1-4d92-8fa6-763c0235093a",
  "customer_custom_fields": {
    "bill_customer_id": "0cu21JDIRIUDQKDS6wmx"
  }
}

{
  "id": "4dcef5c4-ed3b-5d0e-baa4-beec74544158",
  "type": "contract.start",
  "timestamp": "2025-08-07T00:00:00Z",
  "environment_type": "PRODUCTION",
  "contract_id": "33d206f6-7455-49f6-857d-2172c37db68d",
  "contract_custom_fields": {
    "org_key": "g_major"
  },
  "customer_id": "1ed86915-97f1-4d92-8fa6-763c0235093a",
  "customer_custom_fields": {
    "bill_customer_id": "0cu21JDIRIUDQKDS6wmx"
  }
}

{
  "id": "ba0d43a2-9426-5219-9191-becdfb43e102",
  "type": "contract.edit",
  "timestamp": "2025-09-15T17:27:41Z",
  "environment_type": "PRODUCTION",
  "contract_id": "3b1cf6f5-e4ea-449f-acc3-afceffaddea7",
  "contract_custom_fields": {
    "org_key": "g_major"
  },
  "customer_id": "541be796-88fa-4081-8f8f-7ac230c43b2c",
  "customer_custom_fields": {
    "bill_customer_id": "0cu21JDIRIUDQKDS6wmx"
  }
}

{
  "id": "ba0d43a2-9426-5219-9191-becdfb43e102",
  "type": "contract.end",
  "timestamp": "2025-09-15T17:27:41Z",
  "environment_type": "PRODUCTION",
  "contract_id": "3b1cf6f5-e4ea-449f-acc3-afceffaddea7",
  "contract_custom_fields": {
    "org_key": "g_major"
  },
  "customer_id": "541be796-88fa-4081-8f8f-7ac230c43b2c",
  "customer_custom_fields": {
    "bill_customer_id": "0cu21JDIRIUDQKDS6wmx"
  }
}

{
  "id": "ba0d43a2-9426-5219-9191-becdfb43e102",
  "type": "contract.archive",
  "timestamp": "2025-09-15T17:27:41Z",
  "environment_type": "PRODUCTION",
  "contract_id": "3b1cf6f5-e4ea-449f-acc3-afceffaddea7",
  "contract_custom_fields": {
    "org_key": "g_major"
  },
  "customer_id": "541be796-88fa-4081-8f8f-7ac230c43b2c",
  "customer_custom_fields": {
    "bill_customer_id": "0cu21JDIRIUDQKDS6wmx"
  }
}

{
  "id": "23bbd69c-28bb-5f04-b609-ea716b0f00b4",
  "type": "commit.create",
  "timestamp": "2025-08-07T00:00:00Z",
  "environment_type": "PRODUCTION",
  "commit_id": "529a023b-3d3c-52b1-b6d5-4d3dd06c6cb0",
  "commit_custom_fields": {
    "tier_key": "f_minor"
  },
  "contract_id": "33d206f6-7455-49f6-857d-2172c37db68d",
  "contract_custom_fields": {
    "org_key": "g_major"
  },
  "parent_recurring_commit_id": "0719c77c-e3e1-4d1d-bb59-6cee63773f24",
  "customer_id": "1dd86915-97f1-4d92-8fa6-763c0235093a",
  "customer_custom_fields": {
    "bill_customer_id": "0cu21JDIRIUDQKDS6wmx"
  }
}

{
  "id": "33bbd69c-28bb-5f04-b609-ea716b0f00b4",
  "type": "commit.edit",
  "timestamp": "2025-08-07T00:00:00Z",
  "environment_type": "PRODUCTION",
  "commit_id": "529a023b-3d3c-52b1-b6d5-4d3dd06c6cb0",
  "commit_custom_fields": {
    "tier_key": "f_minor"
  },
  "contract_id": "33d206f6-7455-49f6-857d-2172c37db68d",
  "contract_custom_fields": {
    "org_key": "g_major"
  },
  "parent_recurring_commit_id": "0719c77c-e3e1-4d1d-bb59-6cee63773f24",
  "customer_id": "1dd86915-97f1-4d92-8fa6-763c0235093a",
  "customer_custom_fields": {
    "bill_customer_id": "0cu21JDIRIUDQKDS6wmx"
  }
}

{
  "id": "43bbd69c-28bb-5f04-b609-ea716b0f00b4",
  "type": "commit.archive",
  "timestamp": "2025-08-07T00:00:00Z",
  "environment_type": "PRODUCTION",
  "commit_id": "529a023b-3d3c-52b1-b6d5-4d3dd06c6cb0",
  "commit_custom_fields": {
    "tier_key": "f_minor"
  },
  "contract_id": "33d206f6-7455-49f6-857d-2172c37db68d",
  "contract_custom_fields": {
    "org_key": "g_major"
  },
  "parent_recurring_commit_id": "0719c77c-e3e1-4d1d-bb59-6cee63773f24",
  "customer_id": "1dd86915-97f1-4d92-8fa6-763c0235093a",
  "customer_custom_fields": {
    "bill_customer_id": "0cu21JDIRIUDQKDS6wmx"
  }
}

{
  "id": "92adc38c-671c-59dd-8f2e-39fc7482a4df",
  "type": "commit.segment.start",
  "timestamp": "2025-08-07T00:00:00Z",
  "environment_type": "PRODUCTION",
  "commit_id": "529a023b-3d3c-52b1-b6d5-4d3dd06c6cb0",
  "commit_custom_fields": {
    "tier_key": "f_minor"
  },
  "contract_id": "33d206f6-7455-49f6-857d-2172c37db68d",
  "contract_custom_fields": {
    "org_key": "g_major"
  },
  "parent_recurring_commit_id": "0718c77c-e3e1-4d1d-bb59-6cee63773f24",
  "segment_index": 0,
  "segment_count": 1,
  "segment_id": "dea59112-dadb-52c4-8789-304e2cddff92",
  "customer_id": "1ed86915-97f1-4d92-8fa6-763c0235093a",
  "customer_custom_fields": {
    "bill_customer_id": "0cu21JDIRIUDQKDS6wmx"
  }
}

{
  "id": "a2adc38c-671c-59dd-8f2e-39fc7482a4df",
  "type": "commit.segment.end",
  "timestamp": "2025-08-07T00:00:00Z",
  "environment_type": "PRODUCTION",
  "commit_id": "529a023b-3d3c-52b1-b6d5-4d3dd06c6cb0",
  "commit_custom_fields": {
    "tier_key": "f_minor"
  },
  "contract_id": "33d206f6-7455-49f6-857d-2172c37db68d",
  "contract_custom_fields": {
    "org_key": "g_major"
  },
  "parent_recurring_commit_id": "0718c77c-e3e1-4d1d-bb59-6cee63773f24",
  "segment_index": 0,
  "segment_count": 1,
  "segment_id": "dea59112-dadb-52c4-8789-304e2cddff92",
  "customer_id": "1ed86915-97f1-4d92-8fa6-763c0235093a",
  "customer_custom_fields": {
    "bill_customer_id": "0cu21JDIRIUDQKDS6wmx"
  }
}

{
  "id": "23bbd69c-28bb-5f04-b609-ea716b0f00b4",
  "type": "credit.create",
  "timestamp": "2025-08-07T00:00:00Z",
  "environment_type": "PRODUCTION",
  "credit_id": "529a023b-3d3c-52b1-b6d5-4d3dd06c6cb0",
  "credit_custom_fields": {
    "tier_key": "f_minor"
  },
  "contract_id": "33d206f6-7455-49f6-857d-2172c37db68d",
  "contract_custom_fields": {
    "org_key": "g_major"
  },
  "parent_recurring_credit_id": "0719c77c-e3e1-4d1d-bb59-6cee63773f24",
  "customer_id": "1dd86915-97f1-4d92-8fa6-763c0235093a",
  "customer_custom_fields": {
    "bill_customer_id": "0cu21JDIRIUDQKDS6wmx"
  }
}

{
  "id": "33bbd69c-28bb-5f04-b609-ea716b0f00b4",
  "type": "credit.edit",
  "timestamp": "2025-08-07T00:00:00Z",
  "environment_type": "PRODUCTION",
  "credit_id": "529a023b-3d3c-52b1-b6d5-4d3dd06c6cb0",
  "credit_custom_fields": {
    "tier_key": "f_minor"
  },
  "contract_id": "33d206f6-7455-49f6-857d-2172c37db68d",
  "contract_custom_fields": {
    "org_key": "g_major"
  },
  "parent_recurring_credit_id": "0719c77c-e3e1-4d1d-bb59-6cee63773f24",
  "customer_id": "1dd86915-97f1-4d92-8fa6-763c0235093a",
  "customer_custom_fields": {
    "bill_customer_id": "0cu21JDIRIUDQKDS6wmx"
  }
}

{
  "id": "43bbd69c-28bb-5f04-b609-ea716b0f00b4",
  "type": "credit.archive",
  "timestamp": "2025-08-07T00:00:00Z",
  "environment_type": "PRODUCTION",
  "credit_id": "529a023b-3d3c-52b1-b6d5-4d3dd06c6cb0",
  "credit_custom_fields": {
    "tier_key": "f_minor"
  },
  "contract_id": "33d206f6-7455-49f6-857d-2172c37db68d",
  "contract_custom_fields": {
    "org_key": "g_major"
  },
  "parent_recurring_credit_id": "0719c77c-e3e1-4d1d-bb59-6cee63773f24",
  "customer_id": "1dd86915-97f1-4d92-8fa6-763c0235093a",
  "customer_custom_fields": {
    "bill_customer_id": "0cu21JDIRIUDQKDS6wmx"
  }
}

{
  "id": "92adc38c-671c-59dd-8f2e-39fc7482a4df",
  "type": "credit.segment.start",
  "timestamp": "2025-08-07T00:00:00Z",
  "environment_type": "PRODUCTION",
  "credit_id": "529a023b-3d3c-52b1-b6d5-4d3dd06c6cb0",
  "credit_custom_fields": {
    "tier_key": "f_minor"
  },
  "contract_id": "33d206f6-7455-49f6-857d-2172c37db68d",
  "contract_custom_fields": {
    "org_key": "g_major"
  },
  "parent_recurring_credit_id": "0718c77c-e3e1-4d1d-bb59-6cee63773f24",
  "segment_index": 0,
  "segment_count": 1,
  "segment_id": "dea59112-dadb-52c4-8789-304e2cddff92",
  "customer_id": "1ed86915-97f1-4d92-8fa6-763c0235093a",
  "customer_custom_fields": {
    "bill_customer_id": "0cu21JDIRIUDQKDS6wmx"
  }
}

{
  "id": "a2adc38c-671c-59dd-8f2e-39fc7482a4df",
  "type": "credit.segment.end",
  "timestamp": "2025-08-07T00:00:00Z",
  "environment_type": "PRODUCTION",
  "credit_id": "529a023b-3d3c-52b1-b6d5-4d3dd06c6cb0",
  "credit_custom_fields": {
    "tier_key": "f_minor"
  },
  "contract_id": "33d206f6-7455-49f6-857d-2172c37db68d",
  "contract_custom_fields": {
    "org_key": "g_major"
  },
  "parent_recurring_credit_id": "0718c77c-e3e1-4d1d-bb59-6cee63773f24",
  "segment_index": 0,
  "segment_count": 1,
  "segment_id": "dea59112-dadb-52c4-8789-304e2cddff92",
  "customer_id": "1ed86915-97f1-4d92-8fa6-763c0235093a",
  "customer_custom_fields": {
    "bill_customer_id": "0cu21JDIRIUDQKDS6wmx"
  }
}

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.

Interface de liste des notifications montrant différents types de notifications et leur statut

Dans l’interface utilisateur

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

Via l’API

Appelez POST /v2/notifications/edit
Passez la politique de la notification système que vous souhaitez activer (par exemple, contract.create) et is_enabled dé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.

​Types de notifications système

​Exemples de charges utiles de webhook

​Activer et gérer les notifications système

Types de notifications système

Exemples de charges utiles de webhook

Activer et gérer les notifications système