> ## Documentation Index
> Fetch the complete documentation index at: https://docs.useautumn.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Usage Alert Triggered

> Fired when a customer crosses a configured usage alert threshold.

### Payload Fields

<ParamField body="customer_id" type="string" required>
  The ID of the customer whose usage alert was triggered.
</ParamField>

<ParamField body="feature_id" type="string" required>
  The feature ID the alert applies to.
</ParamField>

<ParamField body="entity_id" type="string">
  The entity ID the alert applies to, if the usage was entity-scoped.
</ParamField>

<ParamField body="usage_alert" type="object" required>
  Details of the usage alert that was triggered.

  <Expandable title="properties">
    <ParamField body="name" type="string">
      User-defined label for the alert, if provided.
    </ParamField>

    <ParamField body="threshold" type="number" required>
      The threshold value that was crossed.
    </ParamField>

    <ParamField body="threshold_type" type="'usage' | 'usage_percentage' | 'remaining' | 'remaining_percentage'" required>
      Whether the threshold is an absolute usage count or a percentage.
    </ParamField>
  </Expandable>
</ParamField>


## OpenAPI

````yaml api/openapi.yml webhook balances.usage_alert_triggered
openapi: 3.1.0
info:
  title: Autumn API
  version: 2.3.0
servers:
  - url: https://api.useautumn.com
    description: Production server
security:
  - secretKey: []
paths: {}
components:
  securitySchemes:
    secretKey:
      type: http
      scheme: bearer
      bearerFormat: JWT

````