Report liveness and read the authoritative run state

Records that a browser is alive, renews its exclusive lease on the account, and returns the run state the extension must obey, which is how a change made in the web app (the sender's approval setting, a limit) reaches the browser without a push channel. Also carries the wrong-account guard: if the browser is signed in as somebody other than the bound member, the response says so and the extension must stop. A reported checkpoint is applied only from the browser holding the lease; a browser that does not hold it is told which browser does. While work is queued it also says what the next step waits on and until when, and asks for check-ins at most 15 seconds apart while work is about to run. It says how many of the sender's steps wait for a person on Tasks, less those a paused sequence or paused contact holds, and whether a step that waits for no gap is ready.

post/linkedin/agent/heartbeat/

Request

Base URL: https://api.getoneprofile.ai (the document declares no server; this is the origin it was published from)
URL: https://api.getoneprofile.ai/linkedin/agent/heartbeat/
Auth: API key in header X-API-Key

Request body

checkpointboolean nullable

True when LinkedIn is challenging the account; no work is handed out while it stands. False clears it; null leaves it untouched.

extension_versionstring

lease_noncestring required

This browser's lease identity; only the holder is handed work.

member_urnstring nullable

Who the browser is currently signed in as, for the mismatch guard.

running_action_idstring uuid nullable

The step this browser is running right now, sent on the check-ins it makes while it runs; with running_claimed_at it keeps that step's claim from lapsing under a browser still working on it, including one waking from sleep. Null between steps.

running_claimed_atstring date-time nullable

When the running step was claimed, as the claim handed it out.

running_phase'claimed' | 'navigated' | 'dispatched' | 'committing' | 'committed'

How far a build that resumes says a running step got, on each check-in.

claimed: handed over, nothing done. navigated: on the page. dispatched: the step's own work started. committing: a press that changes LinkedIn was granted and is under way. committed: it was made. Information for the team and for the next look; the grant, not the phase, is what says something may have happened.

supported_kindsstring[] nullable

The step kinds this build can run, and the capabilities it has beyond them (such as profile_view:read_relationship). Nothing is handed to a browser that it cannot run. Leave it out (an older build) and the browser runs the kinds that existed before builds said. Sent on every check-in: a check-in without it reads as such a build.

timezonestring nullable

The browser's IANA timezone (Intl.DateTimeFormat().resolvedOptions().timeZone). It fills the sender's timezone when the sender has none: their daily limits reset at its midnight and sequences send in its hours. A timezone the sender has is never moved by it. Taken only from the browser driving the account.

Response

Successful Response

account_mismatchboolean required

approvals_waitinginteger

How many of this sender's LinkedIn steps wait for a person on Oneprofile's Tasks page, less those a paused sequence or paused contact holds; the side panel offers Approve tasks while any do.

attempts_enabledboolean

Whether a build that reports attempts (attempts:v1) reports a run cut off without an error from LinkedIn to /actions/{id}/attempts/ and runs the step again only on the answer. The same switch as resume_enabled.

checkpointboolean required

config_versioninteger required

The version of the selector and pacing config this server serves. A browser running any other version, older or newer, fetches the config again.

lease_grantedboolean required

lease_holder_labelstring nullable

When lease_granted is false, what the browser holding the lease calls itself (for example 'Chrome on macOS'); null when that is not known.

poll_after_secondsinteger required

How long to wait before the next check-in: the account's own time between steps, never more, and never so long the browser stops reading as active. At most 15 seconds while work is about to run (the time between steps is running out, a step may start now, or one is running with more behind it), so a missed wake-up costs seconds rather than a whole interval.

queued_countinteger required

resume_enabledboolean

Whether a build that resumes steps (resume:v1) may resume one that stopped without an error from LinkedIn. Off, a stopped step fails for a person to retry, as it did before; the grant and the saved results stay on either way.

run_mode'manual' | 'auto' required

Whether a person approves a sender's LinkedIn steps before they run, or they run on their own.

The sender's own LinkedIn setting, kept on the sender beside their email modes so the approval queue reads one home for both. The absence of one (SenderProfileDTO.linkedin_approval_mode is None) reads as MANUAL: nothing runs on somebody's LinkedIn unattended until they have said so. The approval queue still tells "never set" apart from "chose manual", which is the level its settings surfaces name.

running_claim'renewed' | 'lost' nullable

For a check-in that named a running step: renewed while that claim is still this browser's, lost once it is not (settled, rejected, lapsed while the browser was gone, or taken back from a step whose running_wait outlasted every ceiling), and the browser then stops the step before it changes anything more. Null for a check-in that named none.

unpaced_waitingboolean

A step that waits for no gap between steps (one the Oneprofile team fired to test the sender) could be handed out now: ask for it alone (unmetered_only) without waiting out this browser's own gap.

usage_resets_atstring date-time nullable

When today's counts in usage start over: 00:00 in the sender's timezone. Older servers leave it out, and a client then reads the next UTC midnight.

Changes

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