Usage Alerts

Create Usage Alert Endpoint

Changed on
post/v1/usage-alerts

Request

  • Base URL
    https://api.getbluejay.ai
  • URL
    https://api.getbluejay.ai/v1/usage-alerts
  • Auth
    HTTPBearer (a scheme the document does not define)

Headers

X-Organization-Idstring
X-API-Keystring required

API key required to authenticate requests.

Request body

namestring required

Human-readable alert name

alert_type'low_remaining_contract_credit_percentage_reached' | 'low_remaining_contract_credit_balance_reached' | 'spend_threshold_reached' required

the native Metronome alert types we expose, as-is, for usage alerts.

contracts are credits-only, so we alert on remaining balance: percentage (running-low and exhaustion at 0%) and absolute credit balance. spend is kept for legacy/overage-depth alerts.

thresholdnumber required

Threshold in the type's native unit (% , $, or 0 for into-overage)

Response

Successful Response

idstring uuid required
namestring required
metronome_alert_idstring required
is_enabledboolean required
thresholdnumber nullable
alert_typestring nullable
statusstring nullable

Changes

  • aa501502e1fcRevision changes
    • info

      added the new optional header request parameter X-Organization-Id

  • 84e25a31d733Revision changes
    • warning

      added the new webhook enum value to the // response property for the response status

    • info

      added the new webhook enum value to the request property //