FraudAlertEvent

Defines a Fraud Alert Event, including when the alert was triggered and if alert recipients have been notified.

  • fraud_alert_rule_id
    Type: integer
    min:  
    1
    required

    The ID of the Fraud Alert Rule that the alert was triggered for.

  • fraud_alert_rule_name
    Type: string
    read-only
    required

    The unique identifier of the Fraud Alert Rule that the alert was triggered for.

  • metric_type
    Type: stringenum
    read-only
    required

    What was being counted toward triggering a fraud alert for the Fraud Alert Rule.

    values
    • loyalty_enrollment_points_earned
    • loyalty_enrollment_transactions
    • loyalty_enrollment_retro_claims
  • notifications_sent
    Type: boolean
    required

    Whether or not alert recipients have been notified of the specified fraud alert yet.

  • quantity
    Type: integer
    min:  
    1
    required

    The value of the fraud alert metric that triggered the alert (e.g. 1234 earned loyalty points when the triggering rule has a threshold quantity of 1200).

  • created_at
    Type: stringFormat: date-time
    read-only

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • loyalty_enrollment_id
    Type: integer

    The ID of a Sparkfly Loyalty Enrollment that the alert was triggered for. Required for member-specific Sparkfly Loyalty related fraud alerts.

  • store_id
    Type: integer

    The ID of the store associated with the activity that triggered the fraud alert. For rules with a scope of "one_store", this will be the location at which all contributing activity (e.g. points earned) occurred, but for "all_stores", only the most recent transaction (previous contributing transactions could have happened at a different selected store).

  • suppressed_count
    Type: integer

    After this event was logged, how many duplicate (retriggered) alerts were suppressed within the event suppression period specified on the Fraud Alert Rule. This will usually be zero.

  • updated_at
    Type: stringFormat: date-time
    read-only

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z