Accessing job history

All job events are tracked. Events of a job are processed serially, one by one.

$ curl -H "X-Planado-API-Key:XXX" https://api.planadoapp.com/v2/jobs/f93f9291-7823-4092-b5db-ed5eb26d4e75/history | jq
{
  "events": [
    "version": 1,
    "type": "job_created",
    "payload": { ... },
    "context": {
      "source": "api",
      "happened_at": "2020-06-01T07:17:28.225+00:00",
      "created_at": "2020-06-01T07:17:28.843+00:00",
      "user_uuid": null,
      "user_email": null,
      "device_uuid": null
    },
    ... // next versions, 2 to 20
  ]
}

Events are ordered from oldest to newest, in chunks of 20. Every event is linked to one version. To fetch next events, pass after parameter with version number:

$ curl -H "X-Planado-API-Key:XXX" https://api.planadoapp.com/v2/jobs/f93f9291-7823-4092-b5db-ed5eb26d4e75/history?after=20 | jq
{
  "events": [
    ... // versions 21 to 40
  ]
}
Table 1. Fields of jobs elements
Field Type JSON type Can be null Description

version

Integer

Number

No

Each event linked to exactly one version

type

String

String

No

Event type

context

Map

Object

No

Context of the event

payload

Map

Object

No

Event payload

Format of payload is defined by type value. List of event types is open, new types can be added at any time.