Fire a heartbeat now
POST /v1/heartbeats/{heartbeatId}/fire · SDK fireHeartbeat · CLI deployments heartbeat fire
Requires schedules:write.
AuthorizationBearer <token>Opaque bearer credential scoped to one service account and tenant.
heartbeatId*string^[0-7][0-9A-HJKMNP-TV-Z]{25}$x-deployments-environment?stringRequired with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.
^[0-7][0-9A-HJKMNP-TV-Z]{25}$x-deployments-organization?stringRequired with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.
^[0-7][0-9A-HJKMNP-TV-Z]{25}$x-deployments-project?stringRequired with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.
^[0-7][0-9A-HJKMNP-TV-Z]{25}$idempotency-key?stringRequired unless the request body supplies a stable fireKey. Must contain 1–256 UTF-8 bytes with no surrounding whitespace or control characters (U+0000–U+001F and U+007F); maxLength is only a character-count approximation.
^(?!\s)(?!.*\s$)[^\u0000-\u001F\u007F]+$1 <= length <= 256application/json- body
agentDeploymentId*string^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$fireKey?string^\S[\s\S]*\S$|^\S$|^$1 <= lengthFireHeartbeatResponse
application/json- response
duplicate*booleanheartbeatRun*run?curl -X POST "https://example.com/v1/heartbeats/string/fire" \ -H "Content-Type: application/json" \ -d '{ "agentDeploymentId": "string" }'{ "duplicate": true, "heartbeatRun": { "environmentId": "string", "organizationId": "string", "projectId": "string", "completedAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "heartbeatId": "string", "id": "string", "object": "heartbeat-run", "responseKind": "string", "runId": "string", "skipReason": "string", "status": "accepted", "threadId": "string", "version": 0 }, "run": { "runId": "string", "threadId": "string" }}