> For the complete documentation index, see [llms.txt](https://docs.trmnl.com/go/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.trmnl.com/go/plugin-marketplace/plugin-creation.md).

# Plugin Creation

Creating a plugin OAuth client.

You can create a new plugin by visiting the following URL:

```
https://trmnl.com/plugins/my/new
```

{% hint style="info" %}
Building Third Party plugins requires the Developer Edition upgrade on your device. Without it, this page redirects to our upgrade screen.
{% endhint %}

<figure><img src="https://1607647240-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FnXhDs1PQJ2VX7ppA91eY%2Fuploads%2Fgit-blob-6c3affe5fc4fa76d33b6abb818584331d331de9a%2Ftrmnl-plugin-form.png?alt=media" alt="" width="375"><figcaption><p>TRMNL public plugin client</p></figcaption></figure>

You'll have to provide the following information about your plugin.

**Name**: Branded title (if applicable, ex "Vandelay Industries") or brief tag that describes the plugin's functionality

**Description**: Additional text to help differentiate your plugin from others, 35 characters max

**Icon**: PNG or SVG, 512x512px recommended

**No Screen Padding**: Removes the outermost padding when your plugin renders full screen

**Category**: Up to 3 categories that help users find your plugin in our [directory](https://trmnl.com/integrations)

**Supported Refresh Interval**: The fastest refresh interval your plugin can support, from every 15 minutes to once a day. Users can't pick a faster interval than this for their instance

**Installation URL**: Endpoint where TRMNL should trigger the [installation flow](https://docs.trmnl.com/go/plugin-marketplace/plugin-installation-flow.md)

**Installation Success Webhook URL**: Where you want to receive installation success events as a webhook

**Plugin Management URL**: Where TRMNL users can [manage their plugins](https://docs.trmnl.com/go/plugin-marketplace/plugin-management-flow.md)

**Plugin Markup URL:** Endpoint where TRMNL should ping your webserver for [markup content](https://docs.trmnl.com/go/plugin-marketplace/plugin-screen-generation-flow.md)

**Uninstallation Webhook URL**: Where you want to receive [uninstallation events](https://docs.trmnl.com/go/plugin-marketplace/plugin-uninstallation-flow.md) as a webhook

**Knowledge Base URL**: A setup guide for your plugin. We link to it from the plugin's settings page

Every field is required. After you save, your plugin shows up under **My Plugins** (`https://trmnl.com/plugins/my`) with its status, a Client ID + Client Secret, an **Edit** button and an **Install** button. Use **Install** to run the full flow against your own account while the plugin is still in development -- other users can't install it until it's [published](https://docs.trmnl.com/go/plugin-marketplace/going-live.md).
