Skip to content

Adapters

An adapter definition tells calsync how to read one kind of site. Definitions are written in YAML or JSON and edited in the UI. Adding a new site doesn't require any code.

There are three kinds:

  • pipeline: an ordered list of HTTP, extraction and pagination steps. It suits sites backed by a JSON API.
  • html: CSS selectors over a rendered page, fetched statically or in a headless browser.
  • python: built-in adapters only, for sites that need custom code. User-created definitions cannot use this kind.

Coming soon

The full schema reference will land here. calsync will also serve the schema as JSON Schema at /schema/adapter.json.