JoplinInstall

Overview

This node allows you to create a new note in a Joplin notebook via the Joplin API. It is useful for automating the creation of notes, such as logging information, saving web clippings, or integrating with other workflows that require storing structured or unstructured data in Joplin.

Example scenarios:

• Automatically save meeting notes from another app into a specific Joplin notebook.
• Archive emails or messages as notes in Joplin.
• Create daily journal entries programmatically.

Properties

Name	Type	Meaning
Folder ID	resourceLocator	The target notebook where the note will be created. Can be selected from a list, by URL, or by ID.
Title	string (required)	The title of the note.
Additional Fields	collection	Optional fields to further customize the note. See below for details.

Additional Fields options:

• Asignee Name or ID: options
  ID of the user to whom the note is assigned. Select from a list or specify an ID.
• Body: string
  The note body, in Markdown or HTML.
• Source URL: string
  The original source URL for the note.
• Time: fixedCollection
  Set custom creation and update times (epoch timestamps).
  • User_created_time: number
    When the note was created (can be set manually).
  • User_updated_time: number
    When the note was last updated (can be set manually).
• Body_html: fixedCollection
  Provide the note body in HTML format, along with a required base_url.
• Image: fixedCollection
  Attach an image to the note using a Data URL, with optional cropping rectangle.
  • Image_data_url: string
    The image in Data URL format.
  • Crop_rect: boolean
    Whether to crop the image.
  • Optional Rectangle: fixedCollection
    Specify x, y, width, height for cropping.
• GPS: fixedCollection
  Add geolocation data to the note.
  • Latitude: number
  • Longitude: number
  • Altitude: number

Output

The output is a JSON object containing the response from the Joplin API after creating the note. The structure typically includes:

{
  "res": {
    "id": "string",
    "parent_id": "string",
    "title": "string",
    "body": "string",
    // ...other note properties returned by Joplin
  }
}

• The res field contains all properties of the newly created note as returned by the Joplin API.

Dependencies

• Joplin API: Requires access to a running Joplin server with the API enabled.
• API Credentials: You must provide valid Joplin API credentials (baseUrl and token) in n8n under the credential type jApi.
• n8n Configuration: No special configuration beyond setting up the credentials.

Troubleshooting

Common issues:

• Invalid Folder ID: If the folder ID is incorrect or missing, the note cannot be created. Ensure the Folder ID is valid and accessible.
• Missing Required Fields: The "Title" property is required. If omitted, the node will throw an error.
• Authentication Errors: If the API token or base URL is incorrect, authentication will fail. Double-check your credentials.
• Malformed Additional Fields: Providing invalid data types or malformed structures in additional fields may cause errors.

Error messages:

• "Not a valid Joplin note URL": The provided URL does not match the expected pattern.
• "Not a valid Joplin Folder ID": The folder ID does not match the required format.
• API errors (e.g., 401 Unauthorized, 404 Not Found): Usually indicate issues with credentials or resource existence.

How to resolve:

• Verify all required fields are filled.
• Check that the Joplin API is reachable and credentials are correct.
• Use the UI selectors when possible to avoid manual entry errors.

Links and References

• Joplin API Documentation
• n8n Expressions Guide
• Joplin Official Website