Healthcheck

The Kobble API provides a health check endpoint at GET /customers/v1/health for monitoring system availability. Use this endpoint for availability monitoring instead of querying business endpoints.

Usage Notes

No authentication required: This endpoint is publicly accessible

Status values:

Overall status:

UP (all operational)

DEGRADED (some degraded but functional)

DOWN (complete outage)

Service status: UP, DOWN, DEGRADED, or UNKNOWN (timeout/unreachable)

Service details: When status is DEGRADED, check the services object to identify which specific services are affected

Best Practices

When status is DEGRADED, review the services object to understand which operations might be impacted

Responses

🟢200OK

application/json

Platform is UP or DEGRADED (some services still functional). Responses are cached for up to 15 minutes; a fresh probe only runs once the cached result expires.

Bodyapplication/json

Example

{
    "status": "UP",
    "services": {
        "Transactions": "UP",
        "Wallets": "UP",
        "Clients": "UP",
        "Cards": "UP",
        "Endusers": "UP",
        "Card Transactions": "UP",
        "Webhooks": "UP",
        "Rules": "UP"
    },
    "checked_at": "2024-12-04T10:30:00.000Z"
}

🔴503Service Unavailable

Usage Notes

Best Practices

Request

Request Code Samples

Responses

Healthcheck

Usage Notes#

Best Practices#

Request

Request Code Samples

Responses

Usage Notes

Best Practices