Listmonk icon

Listmonk

Interact with a listmonk instance

Overview

The node "Listmonk" allows interaction with a Listmonk instance, which is an open-source self-hosted newsletter and mailing list manager. Specifically, the Campaign - Create operation enables users to create new email campaigns by sending a JSON payload describing the campaign details.

This node is beneficial for automating email marketing workflows, such as creating and managing campaigns programmatically within n8n. For example, you can use it to trigger campaign creation based on external events or data changes, streamlining your communication process.

Properties

Name Meaning
Json Body The JSON body to send when creating or updating lists, campaigns, templates, or testing campaigns. It should contain all necessary fields as per Listmonk's API specification for the chosen operation.

Note: Although the property is named "Json Body," it is used across multiple operations including creating campaigns, so its structure depends on the specific operation context.

Output

The node outputs JSON data representing the response from the Listmonk API after performing the requested operation. For the Campaign Create operation, this typically includes details of the newly created campaign such as its ID, status, and other metadata returned by the API.

If the operation involves binary data (not indicated here), the node would output that accordingly, but for campaign creation, the output is purely JSON.

Dependencies

  • Requires access to a running Listmonk instance.
  • Requires credentials consisting of:
    • Domain URL of the Listmonk API.
    • Username and password for basic authentication.
  • The node uses these credentials to authenticate API requests.

Troubleshooting

  • Authentication errors: Ensure the domain URL does not have trailing slashes and that username/password are correct.
  • Invalid JSON Body: The JSON must conform to Listmonk's API schema for campaign creation; malformed or incomplete JSON will cause errors.
  • API connectivity issues: Verify network access to the Listmonk instance and that the API endpoint is reachable.
  • Permission errors: The authenticated user must have rights to create campaigns in Listmonk.

Links and References

Discussion