Webhook notification when authorizers meet or exceed configured balance thresholds
webhook URL specified when creating the monitoring schedule.
| Field | Type | Description |
|---|---|---|
event_uuid | string | Unique identifier for this webhook event |
type | string | Always BALANCE_THRESHOLD_ALERT for this event type |
schedule_id | string | The monitoring schedule that triggered the alert |
batch_id | string | The batch ID for this balance check run |
alerts | array | List of authorizers that met or exceeded their threshold |
alerts[].authorizer_unique_id | string | Your unique identifier for the authorizer |
alerts[].balance | number | The authorizer’s current balance in dollars |
alerts[].threshold_amount | number | The configured threshold in dollars |
timestamp | string | ISO 8601 timestamp when the event was created |
2xx status code to confirm receipt:
2xx response is not received, the webhook will be retried with exponential backoff for up to 30 minutes.200 quickly and process in the backgroundUnique identifier for the webhook event.
"550e8400-e29b-41d4-a716-446655440000"
The type of the webhook event, always BALANCE_THRESHOLD_ALERT for this event.
"BALANCE_THRESHOLD_ALERT"
The ID of the monitoring schedule that triggered the alert.
"123e4567-e89b-12d3-a456-426614174000"
The batch ID for this balance check run.
"987fcdeb-51a2-3bc4-d567-890123456789"
List of authorizers that met or exceeded their configured threshold.
ISO 8601 timestamp when the event was created.
"2024-01-15T10:30:00Z"