Status

Health and connector liveness

Reports whether the API is healthy and whether the customer's on-device connector has checked in recently (lastSeenAt and lastSyncAt).

get/status

Request

  • Base URL: https://api.automessage.app/v1
  • URL: https://api.automessage.app/v1/status
  • Auth: API key in header X-API-KEY

Response

Status snapshot.

okboolean required
connectorOnlineboolean required

Has the customer's Mac connector checked in recently?

lastSeenAtstring date-time nullable
lastSyncAtstring date-time nullable
versionstring

Example response

{
  "ok": true,
  "sendPause": {
    "reason": "delivery_failures"
  },
  "version": "1.0.0"
}

Changes

No recorded changes to this operation across all 1 revision of this API.