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:
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
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
If you try to create a plugin without setting your authentication strategy, you will be prompted to set this up, with 2 options; selecting:
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.
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.
Example plugin configuration for content blocks
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.
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.
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 have created plugins within your app, you’ll see your complete plugin list in the “Plugin” tab of your app, with options to:
You can also delete your unwanted plugins. In order to do this, simply edit the plugin you want to delete, and select the Delete 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.
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:
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
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
If you try to create a plugin without setting your authentication strategy, you will be prompted to set this up, with 2 options; selecting:
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.
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.
Example plugin configuration for content blocks
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.
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.
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 have created plugins within your app, you’ll see your complete plugin list in the “Plugin” tab of your app, with options to:
You can also delete your unwanted plugins. In order to do this, simply edit the plugin you want to delete, and select the Delete 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.