Skip to main content

Plug Kinto notifications to a collection endpoint.

Project description

Kinto Changes

kinto-changes shows the list of collection timestamps, allowing to poll changes on several collections with one HTTP request.


pip install kinto-changes


In the Kinto settings:

kinto.includes = kinto_changes

# List of buckets/collections to show:
kinto.changes.resources = /buckets/settings

Cache Control

Like cache control in Kinto collections, it is possible to configure Cache-Control headers via some settings:

kinto.monitor.changes.record_cache_expires_seconds = 60

If cache busting query parameters then responses can be cached more agressively. If the setting below is set then a different cache control expiration will be set:

kinto.monitor.changes.record_cache_maximum_expires_seconds = 3600

Advanced options


The changes entries will have a host attribute, that can be used to distinguish changes from several Kinto instances.

kinto.changes.http_host = website.domain.tld

By default, it will rely on the global setting kinto.http_host.

_since sanetizing

When reaching the monitor/changes collection, if the provided _since query parameter is too old, we redirect the clients to the full list of changes (ie. without _since).

Set this setting to control the maximum age allowed. Set to -1 to disable redirection.

kinto.changes.since_max_age_days = 21


  • GET /v1/buckets/monitor/collections/changes/records.

Returns the list of timestamps.

  • GET /v1/buckets/{bid}/collections/{cid}/changeset?_expected={timestamp}.

Returns the following response for the collection:

  • changes: list of records, optionnally filtered with ?_since="{timestamp}"
  • metadata: collection attributes
  • timestamp: records timestamp

Note: the _expected={} querystring parameter is mandatory but can contain any arbitrary value (used for cache busting).


3.2.0 (2020-11-20)

New features

  • Add filtering support in monitor/changes changeset endpoint

3.1.2 (2020-09-30)

Bug fixes

  • Fix crash when collection is unknown and backend running in readonly mode

3.1.1 (2020-09-28)

Bug fixes

  • Bypass storage when redirecting on old _since

3.1.0 (2020-09-22)

New features

  • Redirect clients whose ?_since value is too old (21 days by default)
  • Add support for monitor/changes in changeset endpoints (fixes #173)

Bug fixes

  • Fix validation rule for _since query parameter

3.0.2 (2020-06-02)

Bug fixes

  • Include tombstones in changeset endpoint (fixes #175)

3.0.1 (2020-05-26)

  • Sort changes explicitly by last_modified descending

3.0.0 (2020-04-20)

Breaking changes

  • Switch changeset timestamp from ETag to integer (#168)

2.2.0 (2020-03-26)

New features

  • Add changeset endpoint (#154)

Bug fixes

  • Fix crash with If-None-Match: * (fixes #158)

2.1.1 (2019-12-23)

Bug fixes

  • Use explicit resource timestamp from DB instead of event payload

2.1.0 (2019-02-20)

New feature

  • Send Cache-Control headers if cache busting query parameters or concurrency control request headers are sent (#66)

2.0.0 (2019-01-15)

Breaking changes

  • Requires Kinto >= 12

1.3.0 (2018-10-15)

New feature

  • Add ability to configure cache control headers (#47)

1.2.1 (2018-09-17)

Bug fixes

  • Don’t do anything during a migrate command (fixes #43).

1.2.0 (2018-09-06)

New feature

  • Events are now generated on the monitor/changes collection (#41).

1.1.1 (2018-04-17)

Internal changes

  • Get rid of six

1.1.0 (2017-11-16)

Breaking changes

  • Upgrade to Kinto 7

Bug fixes

  • Disable reify to always get the most accurate timestamp. (#36)

1.0.0 (2017-02-14)

Bug fixes

  • Accessing the monitoring collection when no changes occured don’t fail anymore (fixes #23)
  • The timestamps shown in the monitoring endpoint are now exactly equal (never superior anymore) to the timestamps of the monitored collections.

Breaking changes

  • The change endpoint location is now hard-coded (/buckets/monitor/collections/changes/records) and cannot be configured.
  • The permissions principals cannot be specified anymore. The change endpoint is now always public.
  • The monitor bucket and changes collection are not required anymore and are not created anymore.
  • POST and DELETE are not supported on the changes endpoint anymore.
  • Individual entries (eg. /buckets/monitor/collections/changes/records/{id}) cannot be accessed anymore.
  • The listener was dropped. Configuration must be changed:


kinto.event_listeners = changes
kinto.event_listeners.changes.use = kinto_changes.listener
kinto.event_listeners.changes.http_host = website.domain.tld
kinto.event_listeners.changes.collections = /buckets/settings


kinto.changes.http_host = website.domain.tld
kinto.changes.resources = /buckets/settings

0.5.0 (2017-01-16)

  • Do not force the timestamp of monitored entries (#27)

0.4.0 (2016-11-07)

  • Add the plugin version in the capability (#20)
  • Add collections in the capability (#18)
  • Add a specific setting to override global http_host value (#24)

0.3.0 (2016-05-19)

  • Update to kinto.core for compatibility with Kinto 3.0. This release is no longer compatible with Kinto < 3.0, please upgrade!

0.2.0 (2016-04-25)

  • Addition of the changes capability

0.1.0 (2015-12-22)

  • Initial code.
  • Bucket and collection name configuration.
  • Changes read permissions configuration.
  • Selection of buckets and collections to follow configuration.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for kinto-changes, version 3.2.0
Filename, size File type Python version Upload date Hashes
Filename, size kinto_changes-3.2.0-py2.py3-none-any.whl (10.7 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size kinto-changes-3.2.0.tar.gz (19.3 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page