Getting started
Managing plugins
Creating and configuring your app’s plugins
This guide helps you through the process of managing your plugins, from starting out, to testing all the way through to release. This guide is split out to help guide you through a number of key concepts:
If you try to create a plugin without setting your authentication strategy, you will be prompted to set this up, with 2 options; selecting:
From here, a modal will appear asking for a name and plugin type. The name can be updated later and should be unique for the app you are creating. On overview for the available plugin types can be found here, with more detail found in their dedicated sections in the Environments section below.
After completing this step, you’ll land on a dedicated setup page where you can configure your plugin settings.
In order to activate your plugin for Kit-wide usage, simply click the “Active” toggle and confirm that you want to set it live by clicking “Activate” in the resulting modal.
activating-your-plugin
At this point, the plugin will be available for all accounts that have installed your app.
Once you click this, a confirmation modal will appear, click 
- Creating your plugins
- Configuring plugin authentication
- Testing your plugins
- Activating your plugins
- Managing your existing plugins
Configuring plugin authentication
Before you can start creating plugins, you need to select and set up your authorization strategy for your plugins to let Kit know how to fetch the content needed to let creators use your apps. We currently offer 2 options:OAuth
OAuth
If you require linking of third-party accounts or are sharing sensitive information, we currently only support OAuth authentication. This option will likely be the default for most applications, needing to pull data from a third-party account for the creator in a vast number of use cases. More details on OAuth authorization for plugins can be found in the dedicated OAuth guide.
No authorization
No authorization
If you try to create a plugin without setting your authentication strategy, you will be prompted to set this up, with 2 options; selecting:
- “Continue without authentication” sets your strategy to “No authorization”, or
- “Configure Authentication” takes you to the Authentication tab to set this up
If you disable plugin authentication on the Authentication tab, you’ll see a warning when you return to the Plugins tab. This warning indicates that you need to update authentication settings before your plugins can be active. Click the prompt to go directly to the Authentication tab and make the necessary changes.
Create a new plugin
Once you have selected your authentication method, you’ll be able to create your first plugin! To do this, click on the “Plugins” tab in the sidebar menu when editing your app. When here, click on the ”+ New plugin” button to start the process.
If this is your second app, the ”+ New plugin” button will be located to the right of the Plugin title:
After completing this step, you’ll land on a dedicated setup page where you can configure your plugin settings.
Example plugin configuration for content blocks
Example plugin configuration for content blocks
Details on the JSON required to set plugins up can be found in the plugin cofiguration documentation for the respective plugin environment.
Testing your plugins
So that new plugins can be tested for apps that have already been published, the developer account for an app is able to see all plugins set up for an app within their account regardless of whether they are active or not. This allows you to utilise your production system and your app authentication to test changes in a live system without worrying about other accounts accessing your plugins before they are ready. If you haven’t yet gone live with your app and you want to envision what your plugins will look like for creators, you can start building out your plugins with public API endpoints and the “no authorization” authentication strategy, allowing you to tweak your content before finalising your OAuth authentication flows.Activating your plugin
When you first create your plugin it will be inactive. While inactive it will only be available to test for your developer account, but once activated, the plugin will be visible to any user who has installed the app.You must install your app from the Kit App Store to see your plugins in the editor. To do this, go to the “Build” tab in the Kit App Store, click on “Preview” and install your app.
activating-your-plugin
At this point, the plugin will be available for all accounts that have installed your app.
Managing your plugins
Once you have created plugins within your app, you’ll see your complete plugin list in the “Plugin” tab of your app, with options to:- Activate or deactivate plugins using toggles
- Edit plugin settings
If a plugin is already active on a published app, we don’t recommend editing it until your changes have been thouroughly tested, as all updates to your plugins will take effect immediately, for accounts that have your app installed. Instead, create a new plugin and keep it inactive to test your changes. Once your tests are successful, you can update the original plugin with the new functionality.
Deleting plugins
You can also delete your unwanted plugins. In order to do this, simply edit the plugin you want to delete, and select theDelete Plugin button in the bottom left corner.
Once you click this, a confirmation modal will appear, click Delete and the plugin will be deleted from the app.
This will stop creators from being able to add new instances of this plugin, but won’t remove previously added instances to reduce the chance of broken content. This will allow creators to make the decision themselves on how they want to manage the plugin - by deleting it from their content or using the last valid state they saw.