Table of contents

Konnectors doctype

The io.cozy.konnectors doctype is used to store installed connectors.

Connectors are autonomous applications ran on the stack to connect to external services or API.

When installing a konnector, the Cozy stack creates a new io.cozy.konnector document from the fields in the manifest.konnector. See the reference for more information on each attributes.

io.cozy.konnectors are used by Cozy-Store to install and uninstall connectors, and by Cozy-Collect to manage accounts for connectors

Attributes

Retrieved from manifest.konnector

The available attributes in a io.cozy.konnectors document are :

Other Attributes

Attribute Role
state Store the installation state of the konnector. Value can be AVAILABLE, INSTALLING, UPGRADING, UNINSTALLING, INSTALLED, READY

Example

{
  "name": "Debug",
  "editor": "",
  "slug": "debug",
  "developer": {
    "name": "cozy",
    "url": "cozy.io"
  },
  "long_description": "",
  "short_description": "",
  "categories": ["other"],
  "locales": null,
  "langs": null,
  "tags": null,
  "icon": "",
  "license": "",
  "state": "ready",
  "source": "git://github.com/cozy/cozy-konnector-debug.git#build",
  "parameters": null,
  "version": "1.0.0-edf48da7b2d959517aea59767c3d8d45b2ce7fa2",
  "permissions": {
    "accounts": {
      "type": "io.cozy.accounts",
      "description": "Required to get the account's data",
      "verbs": [
        "GET"
      ]
    }
  }
}