OpenEMM icon

OpenEMM

Consume EMM API
Join our community

Actions8

Overview

This node integrates with the OpenEMM email marketing platform, specifically focusing on managing mailing lists and their recipient bindings. The "Get Recipient Binding" operation under the "Mailing List" resource retrieves the subscription binding details of a specific recipient (identified by email) to a particular mailing list.

Common scenarios where this node is beneficial include:

  • Checking if a recipient is subscribed to a mailing list.
  • Retrieving the status or metadata of a recipient's subscription to a mailing list.
  • Automating workflows that depend on recipient subscription states in OpenEMM.

For example, you might use this node to verify whether a user has an active subscription before sending targeted emails or to audit mailing list memberships programmatically.

Properties

Name Meaning
Authentication Method of authentication; currently supports only "Basic".
Email The email address of the recipient whose binding information you want to retrieve.
Mailing List Name or ID The mailing list to check the recipient's binding against. Can be selected from a list or specified via expression.

Output

The output JSON contains the recipient's binding information for the specified mailing list. This typically includes subscription status and related metadata about the recipient's membership in that mailing list.

No binary data output is produced by this operation.

Example output structure (simplified):

{
  "customer_id": 123,
  "email": "recipient@email.com",
  "mailinglist": "list_id_or_name",
  "status": 1,
  "subscription_date": "2023-01-01T12:00:00Z"
}

(Note: Actual fields depend on OpenEMM API response.)

Dependencies

  • Requires an API key credential configured for Basic Authentication to access the OpenEMM API.
  • The node uses internal helper functions to make RESTful HTTP requests to OpenEMM endpoints.
  • The mailing lists available for selection are dynamically loaded from the OpenEMM instance.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Providing an incorrect email or mailing list ID/name may result in empty or error responses.
    • Network connectivity issues can prevent successful API calls.

  • Error messages:

    • Errors returned from the OpenEMM API will be propagated. For example, "404 Not Found" if the recipient or mailing list does not exist.
    • If the node is set to continue on fail, errors will appear in the output JSON under an error field.

  • Resolutions:

    • Verify API credentials and permissions.
    • Confirm the email and mailing list identifiers are correct and exist in OpenEMM.
    • Check network connectivity and endpoint URLs.

Links and References

Discussion