Version 5

    Summary

     

    Health checks are public endpoints (no authentication required) that provide an overall health summary of an add-on's integration service. The endpoint returns a simple JSON data structure. See Getting Started > Building a Jive Add-On for information about building an add-on.


    Example

     

    The following is an example health check JSON structure:

    {
        "status": "ok", // one of: "ok", "fault", "unknown", "intermittent", "maintenance"
        "lastUpdate": "2013-08-05T18:34:13.779Z",
        "messages": [
            {
                "level": "warn", // one of "info", "warn", "error"
                "summary": "...",
                "detail": "...",
                "fix": "..."
            }
        ],
        "resources": [ // list individual components of the service, and their state
            {
                "name": "...",
                "url": "...",
                "status": "fault", // same enum as overall status
                "lastUpdate": "2013-08-05T18:34:13.779Z",
                "messages": [...]
            }
        ]
    }
    
    
    
    

     

    See below for details on this JSON data structure.

     

    JSON Data Structure

     

    The maximum size for this structure is 64k. If an empty JSON structure is returned, it is the same as returning a response of: "status": "ok".

     

    Basic Structure

    FieldTypeRequiredDescription
    statusString<Enum>no

    ok — All is well. (Default status when no Resource objects are provided)

    fault — Not functional; service is down.

    unknown — Unable to tell; not initialized yet.

    intermittent — Service is partially available; not all features may be available.

    maintenance — Service is not available due to a maintenance window.

    lastUpdateString<Date>noAn ISO-8601 formatted date/time.
    messagesMessage[]noA list of messages associated with this health check. A JSON array of Message objects. (See below)
    resourcesResource[]noA list of components associated with this service. A JSON array of Resource objects (See below)

     

    Message Structure

    FieldTypeRequiredDescription

     

    level

    String<Enum>no

    info — Helpful information. (Default)

    warn — Something is not as expected; functionality may be impaired.

    error — There is a problem.

    summaryStringyesA human readable summary of the problem or state — localized per the Accept-Language header. This should be one or two sentences.
    detailStringnoA human readable detailed description of the problem or state — localized per the Accept-Language header. This should be less than 2000 characters.
    fixStringnoA human readable suggested fix action — localized per the Accept-Language header. This should be less than 2000 characters.

     

    Resource Structure

    FieldTypeRequiredDescription

    name

    StringyesA human readable name of this service — localized per the Accept-Language header.
    urlString<URL>noA URL identifying the service represented by this Resource object.
    statusString<Enum>no

    ok — All is well. (Default)

    fault — Not functional; service is down.

    unknown — Unable to tell; not initialized yet.

    intermittent — Service is partially available; not all features may be available.

    maintenance — Service is not available due to a maintenance window.

    lastUpdateString<Date>noAn ISO-8601 formatted date/time, defaults to "now".
    messagesMessage[]noA list of messages associated with the health of this component. A JSON array of Message objects. (See "Message Structure" above)