Setup, access and Letter Manager integration

Understand newsletter routes and endpoints

Map the AJAX campaign endpoints and public tracking-pixel route without exposing them as ordinary menu pages. The guide then takes you through the correct route, the checks to complete before making changes, the workflow in order, and the evidence to review afterwards.

Audience: System administrators and developersPermission: Staff loginModule v1.0.0
Jump to steps
Where to goCode-backed reference → Email Marketing & Newsletter controller and routes
Before you start
  • Use an authorised account and confirm the source CRM record or setting is correct.
  • Follow the exact route shown above; do not force database values to imitate a completed action.

What you’ll accomplish

Map the AJAX campaign endpoints and public tracking-pixel route without exposing them as ordinary menu pages. These instructions follow the supplied module’s live hooks, controller, model, view and validation flow.

Follow these steps

  1. Use the Letter Manager tab for normal campaign work.
  2. Allow the page JavaScript to call contacts, create, process, history and campaign_details by AJAX.
  3. Allow email clients to request the public open-pixel route.

Fields and options to review

Action scopeMap the AJAX campaign endpoints and public tracking-pixel route without exposing them as ordinary menu pages.
Module version1.0.0
NavigationCode-backed reference → Email Marketing & Newsletter controller and routes
EvidenceVerify the stored record, status, output, email, event or log produced by the code path.

Rules the system enforces

  • The public route email_marketing_newsletter/open/{recipient_id}/{token} maps to Pixel/open.
  • A compatibility pixel/open route is also registered.
  • The campaign controller rejects non-AJAX access to its operational methods.

How to confirm it worked

  • The requested record, output or setting is created or updated through the supported module flow.
  • Any related status, count, email, audit/event, PDF/file or queue evidence agrees with the source action.
  • An error message is investigated rather than bypassed.

Security, privacy and operational checks

  • Apply least privilege and verify the correct customer, lead, sales document or recipient before processing.
  • Protect public tokens, recipient data, IP/browser evidence, templates and exported files according to organisational policy.
  • Test configuration changes with controlled records before production-wide use.
  • Retain or delete evidence only under an authorised retention process.