Heartbeats

Authorization

AuthorizationRequiredBearer <token>

In: header

Request Body

application/jsonRequired

timestampRequiredstring | number

projectRequiredstring

Maximum length: 255

languageRequiredstring

Maximum length: 50

editorRequiredstring

Maximum length: 50

osRequiredstring

Maximum length: 50

branchstring

Maximum length: 255

fileRequiredstring

Maximum length: 255

Response Body

Heartbeat successfully recorded

TypeScript Definitions

Use the response body type in TypeScript.

successboolean

idstring

curl -X POST "https://ziit.app/api/external/heartbeats" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "timestamp": "2023-10-15T14:30:00Z",
    "project": "my-awesome-project",
    "language": "javascript",
    "editor": "vscode",
    "os": "macos",
    "branch": "main",
    "file": "App.js"
  }'

{
  "success": true,
  "id": "string"
}