App developer access is in a closed beta and only developers who receive an invite can join the beta. Join the waitlist here.
With apps that require plugin access, you can add content directly into the ConvertKit app UI. ConvertKit needs to authenticate against the third-party to be able to pull the data required to be rendered within ConvertKit.
For example, if a creator is writing an email to promote a Mighty Network community they run, they can select the events from within the email editor while they are in the context of email writing, and send it out to their email list without ever leaving ConvertKit.
For plugins, authentication goes the opposite way to the API, where ConvertKit needs to authenticate against the third-party to be able to pull the data required to be rendered within ConvertKit.
Once you've created your app with Plugin access required, click on the button "configure".
Configuring Plugin authentication
Choose the authorization strategy you'd like to maintain to access the plugin content.
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.
No authorization: If you are working with public APIs, don’t need to pull any confidential information and are happy to have the content endpoints open, you can select “No authorization”.
OAuth Authorization Strategy
If OAuth is selected, all fields will need to be filled out, sharing all of the authentication details needed for ConvertKit to maintain authorization credentials to access the plugin content.
Create a new plugin
Once this is completed, you can click on “Create a new plugin” button to create new plugins.
You can define all of the top level details and configuration options, which will be dictated by the type of plugin selected.
Details on the JSON required to set plugins up can be found on our plugin documentation.
Publish a new plugin
Once this setup is complete, you are able to complete all of the work to generate the plugin content and can push their app forward for publishing and installation by users. In order for specific plugins to be made available, they also need to be toggled on:
