Get a threshold notification

Retrieve the real-time evaluation status for a specific threshold notification-customer pair. This endpoint provides instant visibility into whether a customer has triggered a threshold notification condition, enabling you to monitor account health and take proactive action based on current threshold notification states.

Use this endpoint to:

• Check if a specific customer is currently violating an threshold notification (in_alarm status)
• Verify threshold notification configuration details and threshold values for a customer
• Monitor the evaluation state of newly created or recently modified threshold notification
• Build dashboards or automated workflows that respond to specific threshold notification conditions
• Validate threshold notification behavior before deploying to production customers
• Integrate threshold notification status checks into customer support tools or admin interfaces

Key response fields:

A CustomerAlert object containing:

• customer_status: The current evaluation state

• ok - Customer is within acceptable thresholds

• in_alarm - Customer has breached the threshold for the notification

• evaluating - Notification is currently being evaluated (typically during initial setup)

• null - Notification has been archived

• triggered_by: Additional context about what caused the notification to trigger (when applicable)

• alert: Complete threshold notification configuration including:

  • Notification ID, name, and type
  • Current threshold values and credit type information
  • Notification status (enabled, disabled, or archived)
  • Last update timestamp
  • Any applied filters (credit grant types, custom fields, group values)

Usage guidelines:

• Customer status: Returns the current evaluation state, not historical data. For threshold notification history, use webhook notifications or event logs
• Required parameters: Both customer_id and alert_id must be valid UUIDs that exist in your organization
• Archived notifications: Returns null for customer_status if the notification has been archived, but still includes the notification configuration details
• Performance considerations: This endpoint queries live evaluation state, making it ideal for real-time monitoring but not for bulk status checks
• Integration patterns: Best used for on-demand status checks in response to user actions or as part of targeted monitoring workflows
• Error handling: Returns 404 if either the customer or alert_id doesn’t exist or isn’t accessible to your organization