Clockwork CRMDocs

Plugins

A plugin adds features to Clockwork CRM. Depending on the plugin, it can add its own menu with pages, tabs on person and company records, and scheduled tasks that run in the background.

Administrator Tools → Plugins lists the plugins available to your Clockwork CRM. Only administrators can install, upgrade or uninstall a plugin.

Open in Clockwork CRMEnter your Clockwork CRM address at the top of the page to open this in your Clockwork CRM.

Finding a plugin

Each plugin in the list shows its name, its author and a short description. Plugins you have already installed are marked Installed.

Search for plugins filters the list as you type. Use the arrows under the list to move between pages.

Select a plugin to open its page.

A plugin's page

The top of the page shows the plugin's name, author, Version and Last updated date, and the Clockwork CRM Verified Plugin badge. View setup guide opens the plugin's own guide.

The main part of the page has a gallery of screenshots, an Overview, a section for each of the plugin's features and, when the plugin has them, its Patch Notes.

The panel on the right has:

Section What it shows
Details The Author and the Languages the plugin is available in
Requirements Clockwork CRM Subscription, which shows Compatible with your plan, and the Clockwork CRM Account Permissions the plugin asks for
Resources A link to the setup guide
Support The author's telephone number, website, email address and support languages
Legal Links to the author's cookie policy and privacy policy

Back returns you to the list.

Permissions a plugin asks for

Under Clockwork CRM Account Permissions, each line starts "This plugin wants to", followed by what it can do, for example "read person records" or "be able to send emails using your email credits". No permissions required means the plugin asks for no access to your Clockwork CRM records.

A plugin can use only the permissions listed here.

Installing a plugin

  1. Open the plugin's page.
  2. Select Install.
  3. Select Confirm on "Are you sure you want to install this plugin?".

When the plugin is installed:

  • Its menu and pages appear straight away.
  • The Everyone team is given permission to the plugin's pages, so every user can use them. To limit who can, change the permissions on your teams. See Teams and permissions.
  • Clockwork CRM creates an API key for the plugin, named after it, with only the permissions the plugin asked for.

When a plugin has its own API, an API Reference item for it appears in the plugin's menu for administrators.

Upgrading a plugin

When a newer version of an installed plugin is available, its page shows "This plugin needs to be upgraded" and an Upgrade button in place of Uninstall.

Select Upgrade and confirm. Your plugin data is kept and updated to the new version.

Uninstalling a plugin

  1. Open the plugin's page.
  2. Select Uninstall.
  3. Confirm "Are you sure you want to uninstall this plugin? All data associated with this plugin will be lost."
  4. Confirm again on "Are you really sure? This cannot be undone."

Uninstalling deletes all the data the plugin stored, its API key and its scheduled tasks, and removes its menu entry. This cannot be undone.

Last updated