Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.staging.metronome.com/llms.txt

Use this file to discover all available pages before exploring further.

System notifications monitor when events or actions occur based on the configured timestamp of an object (e.g contract start) or the time at which an action occurred (e.g. contract created). They’re best for time-based automation workflows around a customer’s key lifecycle events.

​
System notification types

PAYLOAD SCHEMA DIFFERENCESThe payload schema for system notifications differ slightly from the payload schema for threshold notifications. Specifically, the payload for system notifications do not include a properties field. Ensure your webhooks are properly configured to handle both notification types.
TypeNameDetails
Contractcontract.createTriggers when a new contract is created
Contractcontract.startTriggers when a contract is started
Contractcontract.editTriggers when a contract is edited
Contractcontract.endTriggers when a contract ends
Contractcontract.archiveTriggers when a contract is archived
Commit & Creditcommit.createTriggers when a new commit is created
Commit & Creditcommit.editTriggers when a commit is edited
Commit & Creditcommit.archiveTriggers when a commit is archived
Commit & Creditcommit.segment.startTriggers when a commit segment starts

The segment number that triggered the notification and the total number of commit segments can be found in the payload
Commit & Creditcommit.segment.endTriggers when a commit segment ends

The segment number that triggered the notification and the total number of commit segments can be found in the payload
Commit & Creditcredit.createTriggers when a new credit is created
Commit & Creditcredit.editTriggers when a credit is edited
Commit & Creditcredit.archiveTriggers when a credit is archived
Commit & Creditcredit.segment.startTriggers when a credit segment starts

The segment number that triggered the notification and the total number of credit segments can be found in the payload
Commit & Creditcredit.segment.endTriggers when a credit segment ends

The segment number that triggered the notification and the total number of credit segments can be found in the payload

​
Webhook payload examples

{
  "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"
  }
}

​
Enabling and managing system notifications

System notifications can be enabled and managed through both the UI and the API.
Notifications list interface showing various notification types and their status
In the UI
  1. Navigate to the Notifications tab
  2. Find the system notification that you’d like to enable. All available system notifications will appear in the notifications list view and be disabled by default for any account
  3. Click on the notification
  4. Click the toggle next to Status to enable
  5. Confirm action to enable
  6. You will begin receiving notifications about this system event for all customers to all configured webhooks
  7. Ensure your webhooks are set up to properly handle the payloads for these notifications
Via API
  1. Call POST /v2/notifications/edit
  2. Pass in the policy of the system notification you’d like to enable (e.g. contract.create) and is_enabled set to true
  3. A successful response will return a 200 response code
HISTORICAL DATA LIMITATIONWhen you enable a system notification, Metronome starts generating events from that point forward. It does not go back and create events for past data. Additionally, the policy for system notifications cannot be edited.