My Plugins

Start a third-party plugin

Creates the plugin in development status; it publishes from the dashboard after review, not from here. The icon is an upload the dashboard takes. Needs a developer edition device on the account.

post/api/my_plugins

Request

  • Base URL: https://trmnl.com
  • URL: https://trmnl.com/api/my_plugins
  • Auth: HTTP bearer

Request body

namestring
descriptionstring
categorystring[]

One or more of the categories listCategories answers

refresh_every1440 | 720 | 480 | 360 | 240 | 120 | 60 | 30 | 15

Minutes between renders

no_screen_paddingboolean
installation_urlstring

Where an installer is sent to connect; your OAuth authorize page

plugin_management_urlstring nullable

Where an installer manages the connection on your site

plugin_markup_urlstring

Your endpoint that answers the markup for a render

installation_success_webhook_urlstring nullable
uninstallation_webhook_urlstring nullable
knowledge_base_urlstring nullable

Example request

{
  "name": "Metro Schedule",
  "description": "Local train and bus times"
}

Response

Created

Example response

{
  "data": {
    "name": "Metro Schedule",
    "keyname": "metro_schedule"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.