Get an alert

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

Use this endpoint to:

• Check if a specific customer is currently violating an alert threshold (in_alarm status)
• Verify alert configuration details and threshold values for a customer
• Integrate alert 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 alert threshold

• evaluating - Alert has yet to be evaluated (typically due to a customer or alert having just been created)

• null - Alert has been archived

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

• alert: Complete alert configuration including:

  • Alert ID, name, and type
  • Current threshold values and credit type information
  • Alert 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 alert history, use webhook notifications or event logs
• Archived alerts: Returns null for customer_status if the alert has been archived, but still includes the alert configuration details
• Integration patterns: This endpoint can be used to check a customer’s alert status, but shouldn’t be scraped. You should instead rely on the webhook notification to understand when customers are moved to IN_ALARM.
• Error handling: Returns 404 if either the customer or alert ID doesn’t exist or isn’t accessible to your organization