Plugin - Content Management API

Plugins enable developers to replace DatoCMS field components with HTML5 applications so the editing experiences of the DatoCMS web app can be customized.

Object payload

id string

RFC 4122 UUID of plugin expressed in URL-safe base64 format

type string

Must be exactly "plugin"

name string Example: "5 stars"

The name of the plugin

description null, string Example: "A better rating experience!"

A description of the plugin

url string Example: "https://cdn.rawgit.com/datocms/extensions/master/samples/five-stars/extension.js"

The entry point URL of the plugin

parameters object Example: {"devMode":true}

Global plugin configuration. Plugins can persist whatever information they want in this object to reuse it later.

package_name null, string Example: "datocms-plugin-star-rating-editor"

NPM package name of the plugin (or null if it's a private plugin)

package_version null, string Example: "0.0.4"

The installed version of the plugin (or null if it's a private plugin)

permissions Array<string>

Permissions granted to this plugin

meta.version string Example: "2"

Version of the plugin. Legacy plugins are v1, new plugins are v2

Available endpoints

Did this doc help you?

Still need help?

Explore our forum, contact support, or connect with our sales team. You can also chat live with other users in our Slack channel.