Create a heartbeat
POST /v1/heartbeats · SDK createHeartbeat · CLI deployments heartbeat create
Requires schedules:write.
AuthorizationBearer <token>Opaque bearer credential scoped to one service account and tenant.
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*stringMust 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
activeWindow?agentDeploymentId*string^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$instructions*string^\S[\s\S]*\S$|^\S$|^$1 <= length <= 32000intervalMs?integer60000 <= value <= 2592000000skipWhenBusy?booleanthreadId?string^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$timezone?string^\S[\s\S]*\S$|^\S$|^$1 <= length <= 50workspaceId?string^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$HeartbeatResponse
application/json- response
createdAt*string^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$date-timeupdatedAt*string^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$date-timeversion*number|||environmentId*string^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$organizationId*string^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$projectId*string^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$workspaceId?string^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$activeWindow?agentDeploymentId*string^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$createdBy?id*string^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$lastRunAt?string^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$date-timenextRunAt?string^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$date-timeobject*"heartbeat""heartbeat"schedule*status*string"active""archived""disabled""paused""provisioning"threadId?string^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$curl -X POST "https://example.com/v1/heartbeats" \ -H "idempotency-key: string" \ -H "Content-Type: application/json" \ -d '{ "agentDeploymentId": "string", "instructions": "string" }'{ "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "version": 0, "environmentId": "string", "organizationId": "string", "projectId": "string", "workspaceId": "string", "activeWindow": { "daysOfWeek": [ 0 ], "endMinuteOfDay": 0, "startMinuteOfDay": 1439 }, "agentDeploymentId": "string", "createdBy": { "id": "string", "type": "agent" }, "id": "string", "lastRunAt": "2019-08-24T14:15:22Z", "nextRunAt": "2019-08-24T14:15:22Z", "object": "heartbeat", "schedule": { "instructions": "string", "intervalMs": 60000, "skipWhenBusy": true, "timezone": "string" }, "status": "active", "threadId": "string"}