Listmonk icon

Listmonk

Interact with a listmonk instance

Actions32

Overview

The node "Listmonk" allows interaction with a Listmonk instance, which is an open-source self-hosted newsletter and mailing list manager. Specifically, the operation Get Template by ID retrieves a single email template from the Listmonk system using its unique identifier. This is useful when you want to fetch the content or metadata of a specific email template for previewing, editing, or sending campaigns.

Common scenarios include:

  • Fetching a saved email template before sending a campaign.
  • Loading template details into another system for display or modification.
  • Automating workflows that require template data retrieval based on user input or other triggers.

Example: You have a template ID and want to get its HTML content and metadata to customize it dynamically before sending out a newsletter.

Properties

Name Meaning
ID The unique identifier of the template object to retrieve. This is a required string input.

Output

The output JSON will contain the details of the requested template identified by the provided ID. Typically, this includes fields such as the template's name, subject, content (HTML or text), creation date, and other metadata relevant to the template in Listmonk.

If the node supports binary data output (not explicitly shown here), it would likely represent attachments or media related to the template, but this operation primarily returns JSON data describing the template.

Dependencies

  • Requires connection to a Listmonk instance via its API.
  • Needs credentials including domain URL, username, and password for basic authentication.
  • The base URL for API requests is constructed from the provided domain credential.
  • The node expects the Listmonk API to be accessible and properly configured.

Troubleshooting

  • Invalid ID or Template Not Found: If the provided template ID does not exist, the node may return an error or empty response. Verify the ID is correct.
  • Authentication Errors: Ensure the API credentials (domain, username, password) are valid and have sufficient permissions.
  • Network Issues: Confirm the Listmonk server is reachable from n8n and the base URL is correctly set without trailing slashes.
  • API Changes: If Listmonk updates their API, some fields or endpoints might change, causing errors. Check compatibility if issues arise after upgrades.

Links and References

Discussion