Listmonk Service icon

Listmonk Service

Call listmonk service endpoints.

Actions9

Overview

The node implements sending transactional messages using the Listmonk service. It allows users to send emails based on predefined templates to specific subscribers identified either by their subscriber ID or email address. This is useful in scenarios where automated, personalized transactional emails need to be sent, such as order confirmations, password resets, or notification alerts.

Practical examples:

  • Sending a purchase receipt email immediately after an order is placed.
  • Dispatching a password reset link when a user requests it.
  • Notifying a subscriber about changes to their account status.

Properties

Name Meaning
Template ID ID of the email template to use for sending the message (number).
Sender Email The sender's email address configured in Listmonk (string).
Use Messenger The messenger type used to send the message; currently supports "email" (string).
Content Type Format of the message content; options are HTML, Markdown, or Plain text.
Data Optional JSON data to populate dynamic fields in the template (JSON object).
Subscriber Identifier Method to identify the subscriber: by Subscriber ID or Subscriber Email (options).
Subscriber ID The numeric ID of the subscriber to whom the message will be sent (required if identifier is Subscriber ID).
Subscriber Email The email address of the subscriber to whom the message will be sent (required if identifier is Subscriber Email).

Output

The node outputs JSON data representing the result of the transactional message send operation. This typically includes confirmation details such as success status, message IDs, or error information if the send failed.

No binary data output is involved.

Dependencies

  • Requires access to a Listmonk service instance with API enabled.
  • Needs an API authentication token or key configured in n8n credentials to authorize requests.
  • The base URL for the Listmonk API must be correctly set in the node credentials.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials leading to authorization errors.
    • Incorrect Template ID causing the message send to fail.
    • Mismatch between subscriber identifier and provided subscriber info (e.g., providing email when ID is expected).
    • Malformed JSON in the optional data field causing request rejection.
  • Error messages:

    • Authorization errors: Check that the API key/token is valid and has necessary permissions.
    • Template not found: Verify the Template ID exists in Listmonk.
    • Subscriber not found: Confirm the subscriber ID or email is correct and exists.
    • JSON parse errors: Ensure the data property contains valid JSON.

Links and References

Discussion