Skip to main content

Agent heartbeat: report status, receive commands and the latest release

PUT 

/api/v1/connectors/:connector_id/agent/status

Called by the agent after every Sage check and at least every heartbeat_seconds, with its own key (any other key: 403 AGENT_KEY_NOT_THIS_CONNECTOR). The body is stored as the connector's agent_status; it carries numbers and ids only, never invoice content. Lists are capped (parked 200, needs_supplier 200), reason is clipped to 300 characters. Pending commands ride in the answer, oldest first, and are marked delivered. The first heartbeat after the agent was marked offline brings it back online (an Activity Feed event and one e-mail). A heartbeat on a key a rotate_key just handed out swaps it in and revokes the old one.

Requestโ€‹

Responsesโ€‹

Successful Response