Webhooks
Receive real-time notifications when events occur in your apitree account. Configure webhook endpoints to stay informed.
Available Events
Event
Description
api.call.successAPI call completed successfullyapi.call.errorAPI call failedbilling.credit_lowCredit balance below 20% or 5% of included creditsbilling.credit_exhaustedCredit balance exhausted — paid API calls blockedbilling.auto_topup_chargedAuto top-up charged and credits grantedbilling.auto_topup_disabledAuto top-up turned off (payment failure or no billing key)billing.auto_topup_cap_reachedAuto top-up paused — monthly cap reached (resumes next month)billing.subscription.cancel_scheduledSubscription cancellation scheduled for period endbilling.subscription.cancel_undoneSubscription cancellation undone (reactivated)billing.subscription.cancelledSubscription cancelled (period ended or payment failed)billing.subscription.renewedSubscription renewed and credits grantedbilling.subscription.renewal_failedSubscription renewal payment failedsla.breachAPI SLA threshold exceededhealing.resolvedSelf-Healing auto-recovered an APIsettlement.paidProvider settlement completedPayload Format
{
"event": "api.call.success",
"timestamp": "2026-04-09T10:30:00Z",
"data": {
"api_id": "weather",
"latency_ms": 234,
"credits_used": 0.005,
"cached": false,
"request_id": "req_abc123"
}
}Webhook configuration is available in the dashboard settings. Enterprise plans support custom retry policies.