joplin/readme/api/index.md

Extending Joplin

Joplin provides a number of extension points to allow third-party applications to access its data, or to develop plugins.

The two main extension points are:

Data API

The data API provides access to Joplin data to external applications. It is possible, using standard HTTP calls, to create, modify or delete notes, notebooks, tags, etc. as well as attach files to notes and retrieve these files.

This is for example how the web clipper communicates with Joplin, and this is most likely what you will need if you have an external application that needs access to Joplin data.

To get started with the data API, check the documentation.

Plugin API

With plugins you can directly modify Joplin by adding new features to the application. Using this API, you can:

• Access notes, folders, etc. via the data API
• Add a view to display custom data using HTML/CSS/JS
• Create a dialog to display information and get input from the user
• Create a new command and associate a toolbar button or menu item with it
• Get access to the note currently being edited and modify it
• Listen to various events and run code when they happen
• Hook into the application to set additional options and customise Joplin's behaviour
• Create a module to export or import data into Joplin
• Define new settings and setting sections, and get/set them from the plugin
• Create a new Markdown plugin to render custom markup.
• Create an editor plugin to modify, at a low-level, the behaviour of the Markdown editor (CodeMirror)

To get started with the plugin API, check the Get Started page or have a look at the TOC tutorial.

Once you are familiar with the API, you can have a look at the plugin API reference for a detailed documentation about each supported feature.