Skip to content

Dataset.refreshed

Emitted each time a Dataset is refreshed.

Dataset.refresh emits Dataset.refreshed when it completes on a Dataset.

PropertyValue
Emitted byDataset.refresh
NounDataset
WakesNone.

Payload

Each delivery is an Event record. data holds what Dataset.refresh returns.

FieldTypeRequiredDescription
namestringrequiredDataset.refreshed.
atdatetimerequiredWhen it happened.
seqintegerIts position in the namespace, one more than the Event before; any seq is a cursor into the history.
datajsonrequiredThe Thing as the Action left it.
data.datasetDatasetrequiredThe Dataset, with refreshedAt set.
data.dataset.namestringrequiredThe name of the Product.
data.dataset.promisetextrequiredWhat the Customer can rely on.
data.dataset.statusstringrequiredOne of draft, selling or retired, set by its Offers.
data.dataset.recordsintegerHow many Things it holds.
data.dataset.refreshedAtdatetimeWhen its Sources were last read.

Example

JSON
{
  "$id": "https://api.sb/ratebook.dev/events/evt_VptuoPCf4s",
  "$type": "Event",
  "name": "Dataset.refreshed",
  "at": "2026-10-22T12:00:00Z",
  "data": {
    "dataset": {
      "$id": "https://api.sb/ratebook.dev/datasets/dataset_UDQXk0KsJB",
      "$type": "Dataset",
      "name": "Ratebook",
      "promise": "A rate for any US address in under 100 milliseconds.",
      "status": "draft",
      "records": 1,
      "refreshedAt": "2026-10-22T12:00:00Z"
    }
  },
  "seq": 563
}