CatalogEvent

A catalog check finished, whether the background interval, check-on-open or refreshCatalog started it. data is the check's outcome, the same object refreshCatalog answers with.

eventstringrequired

Constant value: catalog

data objectrequired

checkedAtstring<date-time>required

When the check finished.

outcomeCatalogCheckOutcomerequired

How a catalog check ended.

Possible values: [updated, unchanged, failed]

newTemplatesinteger

Templates the new catalog lists that the replaced one did not. Present only when outcome is updated.

Possible values: >= 0

updatedTemplatesinteger

Templates both catalogs list under a different revision. Present only when outcome is updated.

Possible values: >= 0

reasonstring

Present only when outcome is failed. fetch_failed: the host could not be reached or answered something unusable (not notified). bad_signature: the signature does not verify against the catalog key. not_newer: the serial is not higher than the installed catalog's. bad_archive: the signed archive is not a catalog. install_failed: the verified archive could not be written to disk. The three verification reasons raise a catalog_check_failed notification.

Possible values: [fetch_failed, bad_signature, not_newer, bad_archive, install_failed]

messagestring

Present only when outcome is failed.

CatalogEvent

{
  "event": "catalog",
  "data": {
    "checkedAt": "2024-07-29T15:51:28.071Z",
    "outcome": "updated",
    "newTemplates": 0,
    "updatedTemplates": 0,
    "reason": "fetch_failed",
    "message": "string"
  }
}