If you're interested in building plugins (even if only for your own use) and would be interested in a chance to influence the plugin system, feel free to email support@amplenote.com from the email address associated with your account. Feedback can be provided in the #plugin-atelier channel on our discord.
Amplenote provides support for client-side plugins that execute in the application on all platforms, allowing for enhancement of the default client behavior. A plugin is defined by a single note in a user's account - as the note is changed and updated, the plugin will be updated as well.
These documents provide an overview of what plugins are capable of, and describe the available options for plugins. Related help pages that may be of use to plugin authors include:
Guide to getting started writing plugins, a page to help writing your first plugin.
How to apply markdown formatting explains how to produce colored text, line breaks, Rich Footnotes, tables, etc via the Plugin API's functions
These pages are the most comprehensive reference guide of Plugin API functionality. The sections are as follows:
linkUpdate history
link2025
Add app.openEmbed
Add onNoteCreated action
link2024
Q4 2024
October 2024
August 2024
July 2024
June 2024
Add eventOption action
Add width to image type
Adjust app.openSidebarEmbed to re-render when called repeatedly
May 2024 (mobile app version 3.98)
Add renderEmbed and onEmbedCall actions
Add taskOption actions
Add created, updated, shared, published, and vault attributes to NoteHandles
Document imporant and urgent attributes of task objects
April 2024 (mobile app version 3.94)
March 22nd, 2024 (mobile app version 3.92)
March 10th, 2024 (mobile app version 3.90)
February 20th, 2024 (mobile app version 3.90)
February 8th, 2024 (mobile app version 3.89)
Add app.deleteNote / note.delete
Add limit option for app.prompt "tags" input type
January 19th, 2024 (mobile app version 3.88)
January 12th, 2024 (mobile app version 3.88)
check functions for replaceText actions can return a string that will be used as the replacement text, instead of the name of the plugin.
app.alert actions entries can include a value that will be returned if the action is selected, instead of the index of the action in the actions array
Add support for actions in app.prompt
Add "string" input type for app.prompt
link2023
Dec 2023 (mobile app version 3.87)
check functions for insertText actions can return a string that will be used as the replacement text, instead of the name of the plugin. Example
check functions for dailyJotOption actions can return a string that will be used as the text on the button instead of "Run".
Add "tags" app.prompt input type
Add options.primaryAction to app.alert
Dec 1st, 2023 (mobile app version 3.86)
Add section.heading.href field
Add "secureText" app.prompt input type
November 17th, 2023 (mobile app version 3.86)
Add app.addNoteTag / note.addTag
November 8th, 2023 (mobile app version 3.84)
October 23rd, 2023 (mobile app version 3.83)
Add task.endAt
October 13th, 2023 (mobile app version 3.83)
Add task.repeat
September 29th, 2023 (mobile app version 3.83)
Add scrollToEnd option to app.alert
September 22nd, 2023 (mobile app version 3.81)
Add app.getNoteURL and note.url
September 18th, 2023 (mobile app version 3.80)
Add linkOption action type
September 8th, 2023 (mobile app version 3.80)
Add app.getTaskDomains
September 4th, 2023 (mobile app version 3.78)
Add app.context.link and app.context.updateLink
August 28th, 2023 (mobile app version 3.78)
Add app.setSetting
July 31st, 2023 (mobile app version 3.73)
Add noteUUID to task object
June 26th, 2023 (mobile app version 3.71)
Add dailyJotOption action type
Add inputs[i].value option for app.prompt inputs.
Add query option to app.filterNotes
June 15th, 2023 (mobile app version 3.71)
Add support for plugin action check functions, to determine if the plugin should be shown as an option
June 2023 (mobile app version 3.71)
Update app.notes.find to allow either a noteHandle argument or a UUID argument
Add imageOption actions
Add app.context.updateImage
May 22nd, 2023 (mobile app version 3.70)
Add app.saveFile
Add score to task
May 12th, 2023 (mobile app version 3.70)
Add appOption action
Add app.getNoteTasks, app.updateTask, and note.tasks
Include taskUUID in app.context when insertText or replaceText actions are invoked in a task.
April 30th, 2023 (mobile app version 3.67)
Add app.attachNoteMedia
Add type: "radio" to app.prompt
April 18th, 2023 (mobile app version 3.66)
Add app.context.replaceSelection
April 12th, 2023 (mobile app version 3.66)
Rename app.insertContent to app.insertNoteContent - app.insertContent will remain as an alias to support existing plugins using it.
Add options.atEnd to app.insertNoteContent
April 11th, 2023 (mobile app version 3.66)
Add app.getNoteSections/ note.sections
Add app.replaceNoteContent / note.replaceContent
April 7th, 2023 (mobile app version 3.66)
Add { type: "note" } input type to app.prompt
April 6th, 2023 (mobile app version 3.65)
Add app.navigate
March 31st, 2023 (mobile app version 3.65)
Add app.context
Throw exception from insertTask and insertContent when target note is locked/readonly
Handle markdown tables (e.g. "|||\n|-|-|\n|table|content|") in insertContent
March 30th, 2023 (mobile app version 3.65)
Update app.alert to allow for additional action buttons
Update app.prompt to allow for various input types
Removes options.placeholder from app.prompt
March 28th, 2023
Add options.preface to app.alert
Add options.placeholder to app.prompt
March 9th, 2023
insertText changed to insertContent, handling markdown content
insertTask text attribute changed to content, handling markdown content