harvester.checkin

Harvester checked in

Emitted when Vojo hears from a Harvester and records its last check-in, at most once per Harvester every 5 minutes, so a Harvester that stays online sends one event about every 5 minutes. Treat a Harvester as offline when you have had no event for it for longer than that (for example 15 minutes). The time is when Vojo received the data, not the device's own clock, so it never moves backwards when a Harvester that was offline catches up on old readings. Scoped like the screen events: an endpoint limited to some screens or sites hears only Harvesters on those screens or sites, and a Harvester that is not on a screen reaches only endpoints that cover the whole organisation. Existing endpoints must subscribe to it explicitly. To read the same state on demand, use GET /v1/harvesters.

Payload

  • eventTypestringRequired

    Always harvester.checkin

  • eventIdstringRequired

    Stable per-event id, constant across retries (injected at delivery). Dedupe on this.

  • deviceIdstringRequired

    The Harvester's id (the same value as harvesterId).

  • deviceTypestringRequired

    Always harvester

  • lastCheckinstringRequired

    When Vojo last heard from the Harvester, epoch seconds (when Vojo received the data).

    matches ^\d{10}$

  • harvesterIdstringRequired
  • screenIdstring or nullRequired

    The screen the Harvester is on, or null when it is not on one.

  • organisationIdstringRequired

    The organisation that owns the Harvester (the endpoint's own organisation).

  • lastCheckinAtstringRequired

    The same instant as lastCheckin, as ISO-8601 UTC.

    date-time

  • attemptIdstring

    Per-attempt id; CHANGES on each retry. Do not dedupe on this.

  • livemodeboolean

    False for an integrator sandbox's endpoint, true otherwise (injected at delivery).

Handling this event

Verify the signature, reply with a 2xx within 20 seconds, then process the event in the background. Retries reuse the same event id, so deduplicate on it.