OpenEMM icon

OpenEMM

Consume EMM API
Join our community

Actions8

Overview

This node integrates with the OpenEMM email marketing platform to manage recipients. Specifically, the Recipient - Get operation retrieves recipient profile data from OpenEMM based on specified recipient fields. This is useful when you want to fetch detailed information about one or more recipients, such as their subscription status, custom profile fields, or other metadata stored in OpenEMM.

Common scenarios include:

  • Fetching recipient details before sending targeted mailings.
  • Synchronizing recipient data with other systems.
  • Verifying recipient information for segmentation or reporting.

Example: You can use this node to get a recipient’s profile by specifying certain fields (e.g., email) and retrieve all matching data stored in OpenEMM.

Properties

Name Meaning
Authentication Method of authentication; currently supports only "Basic" authentication.
Recipient Fields Profile fields of the recipient to filter or retrieve. Each field consists of:
- Field Name or ID: Selectable from a dynamically loaded list of recipient fields.
- Field Value: The value to match for the corresponding field.

The Recipient Fields property allows multiple entries, enabling filtering by multiple criteria simultaneously.

Output

The output is a JSON array where each item corresponds to a recipient record retrieved from OpenEMM. Each JSON object contains key-value pairs representing the recipient's profile fields as returned by the API.

No binary data output is produced by this operation.

Example output snippet:

[
  {
    "email": "recipient@example.com",
    "firstName": "John",
    "lastName": "Doe",
    "status": 1,
    ...
  }
]

Dependencies

  • Requires an active connection to an OpenEMM instance with API access enabled.
  • Requires an API key credential configured in n8n for Basic authentication.
  • Uses OpenEMM RESTful API endpoints to perform operations.
  • The node depends on helper functions (emmRestfulRequest) to communicate with OpenEMM.

Troubleshooting

  • Empty results: If no recipients are returned, verify that the specified recipient fields and values exactly match existing records in OpenEMM.
  • Authentication errors: Ensure the API key credential is correctly set up and has sufficient permissions.
  • Invalid field names: Use the dynamic load option to select valid recipient fields; manually entered field names must match OpenEMM field IDs.
  • API request failures: Network issues or incorrect OpenEMM URL configuration can cause errors; check connectivity and credentials.
  • Error messages: Errors thrown by the node will include the API error message. If continueOnFail is enabled, errors will be returned as JSON objects with an error property.

Links and References

Discussion