TRMNL Octri Demo
POST/api/my_plugins

Start a third-party plugin

Creates a third-party plugin in development status for your account. Provide plugin metadata and integration URLs; refresh_every, when supplied, must be one of the offered intervals. You need a developer edition device on the account, and publishing happens from the dashboard after review.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

11 body fields

Metadata and integration URLs for the third-party plugin. The plugin is created in development status.

categoryarray<string>optional
One or more of the categories listCategories answers
descriptionstringoptional
A description of the plugin. Maximum 35 characters.
installation_success_webhook_urlstringoptional
The URL to call after a plugin installation succeeds.
installation_urlstringoptional
Where an installer is sent to connect; your OAuth authorize page
knowledge_base_urlstringoptional
The URL of the plugin's knowledge base.
namestringoptional
The plugin's name.
no_screen_paddingbooleanoptional
Whether the plugin's content is displayed without screen padding.
plugin_management_urlstringoptional
Where an installer manages the connection on your site
plugin_markup_urlstringoptional
Your endpoint that answers the markup for a render
refresh_everyintegeroptional
Minutes between renders
Allowed:1440720480360240120603015
uninstallation_webhook_urlstringoptional
The URL to call when the plugin is uninstalled.

4 status codes
200Returns the created plugin data, including its identifier, name, categories, integration URLs, and refresh interval.
dataobjectoptional
401Returned when the request is not authenticated.
errorstringoptional
403Returned when the account does not have a developer edition device.
422Returned when the submitted refresh rate is not one of the intervals supported by the plugin API.

Error handling

A 401 is returned when the request is not authenticated. A 403 is returned if the account has no developer edition device. A 422 is returned when refresh_every is not an offered interval; when supplied, it must be one of 1440, 720, 480, 360, 240, 120, 60, 30, or 15 minutes.