Skip to main content
Metronome provides programmatic notifications in the form of webhooks. If you configure a webhook URL, Metronome sends an HTTP POST request to that URL when certain events occur, such as a contract being created, a threshold being reached or an invoice being finalized. Your service can then react to that notification by updating customer state, sending an email, or notifying internal users to take some action. For how to receive and verify notifications, see Set up webhooks. To inspect delivery history, see monitor webhooks.

​
Webhook Types

Metronome sends these webhook types:

​
Threshold Notifications

alerts.<notification_type> Threshold notifications monitor real-time metrics and trigger when defined thresholds are crossed. See our threshold notifications documentation for more on how to configure these types of notifications Threshold notifications have this structure:

​
System and offset notifications

System notifications for contract, credit, commit, subscription, and invoice events contract.<notification_type> commit.<notification_type> credit.<notification_type> subscription.<notification_type> invoice.void 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). See our system notifications documentation for more on how to configure these types of notification System notifications have this structure:
Offset notifications for contract, credit, commit, and subscription affiliated events Offset notifications allow you to schedule notifications to fire relative to a known date (e.g. a commit’s end date or a contract’s creation date). See our offset notifications documentation for more on how to configure these types of notification Offset notifications have this structure:
Invoice finalized notifications invoice.finalized Triggered whenever an invoice is finalized (happens after the grace period). Invoice finalized notifications have this structure:
NOTIFICATION CONFIGURATIONContact us via the Metronome support portal to set up invoice.finalized notifications.

​
External notifications

Billing provider error notifications (Stripe) invoice.billing_provider_error Billing provider error webhooks only apply to Stripe and are triggered any time there is an error in sending an invoice to Stripe (for example, the customer does not exist within Stripe or the customer does not have a valid payment method). No additional configuration is needed for this webhook; notifications are automatically sent when a webhook destination is set up and the Stripe integration is enabled on the account. Note that no Metronome webhook is triggered for errors residing entirely within Stripe (such as payment failures). Billing provider error notifications have this structure:
Integration Issues integration.issue Integration issue webhooks are triggered when there is an error with the client’s third party integration (for example, invalid credentials, misconfigured connections, or API errors). No additional configuration is needed; notifications are automatically sent when a webhook destination is set up and the integration is enabled. Integration issue notifications have this structure:
AWS marketplace notifications marketplaces.aws_metering_disabled Triggered when an AWS marketplace customer is disabled AWS marketplaces metering notifications have this structure:
Azure marketplace notifications marketplaces.azure_metering_disabled Triggered when an Azure marketplace customer is disabled Azure marketplaces metering notifications have this structure:
GCP marketplace notifications marketplaces.gcp_metering_disabled Triggered when a GCP marketplace customer is disabled GCP marketplaces metering notifications have this structure:

​
Payment gating notifications

Payment gating notifications are tied to specific workflows in Metronome that gate access to some product (e.g. commit balance) based on successful payment collection. Payment threshold reached This webhook is fired when a payment gating action is triggered, such as when a customer hits their threshold_amount for Threshold Billing. Payment gate status After a payment is attempted for a payment gate workflow, this webhook returns the status. It includes relevant metadata from the gateway, such as error codes, if applicable. Payment gate action required This webhook is fired if an additional action is required to complete payment. It includes relevant metadata to identify the associated payment in the gateway, if applicable. External workflow initiated If processing payment via an external gateway outside of a native Metronome integration, this webhook will provide you the information to process that transaction. The workflow_id provided is used to release or cancel the balance, pending payment outcome. Payment gating notifications have this structure: