Webhooks
Balance Threshold Alert
Webhook notification when authorizers meet or exceed configured balance thresholds
WEBHOOK
Balance Threshold Alert Webhook
When a scheduled balance check finds authorizers whose balance meets or exceeds their configured threshold, a notification is sent to thewebhook URL specified when creating the monitoring schedule.
If your webhook endpoint restricts inbound traffic by IP, make sure to allowlist Rightfoot’s outbound IPs. See IP Allowlisting.
Payload Structure
Payload Fields
| 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[].institution_name | string | The name of the financial institution this authorizer is tied to |
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 |
Webhook Response
Your webhook endpoint should respond with an HTTP2xx status code to confirm receipt:
If a
2xx response is not received, the webhook will be retried with exponential backoff for up to 30 minutes.Implementing a Webhook Endpoint
Here are examples of implementing a webhook endpoint to handle threshold alerts:Best Practices
- Act on alerts promptly - Threshold alerts indicate optimal payment timing
- Handle duplicates - Your system should be idempotent
- Log all events - Keep an audit trail of threshold alerts
- Monitor failures - Set up alerts for webhook processing errors
- Process asynchronously - Return
200quickly and process in the background
Body
application/json
Unique identifier for the webhook event.
Example:
"550e8400-e29b-41d4-a716-446655440000"
The type of the webhook event, always BALANCE_THRESHOLD_ALERT for this event.
Example:
"BALANCE_THRESHOLD_ALERT"
The ID of the monitoring schedule that triggered the alert.
Example:
"123e4567-e89b-12d3-a456-426614174000"
The batch ID for this balance check run.
Example:
"987fcdeb-51a2-3bc4-d567-890123456789"
List of authorizers that met or exceeded their configured threshold.
ISO 8601 timestamp when the event was created.
Example:
"2024-01-15T10:30:00Z"
