Marketing

getodden/crm-marketing adds email marketing and lead capture to Odden. It stores everything in your database, links every record to Core's contacts, companies, and lists, and builds its emails with getodden/mail.

composer require getodden/crm-marketing
php artisan migrate

The package registers Odden\Marketing\MarketingServiceProvider through package discovery. See Installation for the full setup, and Core concepts for contacts, companies, and lists.

The two halves#

The module has an email side and a lead side.

Email

• Campaigns: audiences, scheduling, local-time and send-time optimization, A/B tests, proofs, open and click tracking
• Email templates: templates built from mail builder slots, revisions, translations, merge tags, smart content, dynamic images, and AMP
• Subscriptions and compliance: unsubscribe links, the preference center, subscription topics, and double opt-in
• Deliverability: the suppression list, ESP bounce and complaint webhooks, content linting, domain checks, and the sunset policy
• Transactional email: the HTTP API that sends a template to one recipient or a batch

Leads

• Forms and landing pages
• Web tracking
• Lead scoring
• Workflows
• Events and gated assets
• Inbound webhooks and events API
• Attribution

Models#

All models live in Odden\Marketing\Models. The email side uses these:

The lead side adds forms, landing pages, visitor sessions, scoring rules, workflows, events, assets, NPS surveys, and SMS messages. Their pages document them.

Tables without a config key use fixed names.

Enums#

Each enum has getLabel(), and all but CampaignType have getColor() (a Filament color name).

Relations added to Contact#

When the package boots, it adds these relations to Odden\Core\Models\Contact:

When Core merges two contacts, Marketing moves every row it keys to the duplicate contact over to the surviving one, and on a company merge it moves custom behavioural events. Where both contacts have a row that can only exist once, such as two recipients of the same campaign, it keeps one. Opt-outs carry over: see Merging contacts.

Core's contacts table also carries the marketing columns this package migrates in: marketing_topics, marketing_verification_token, marketing_email_verified_at, last_marketing_email_sent_at, is_unengaged, unengaged_since, and sunset_stage.

Sending mail#

Every email the package sends is queued, never sent during the request or command that triggers it:

• campaign messages, from DispatchCampaignAction, marketing:dispatch-scheduled, and marketing:evaluate-ab-tests (see Campaigns)
• workflow send_email steps
• campaign proofs (SendCampaignProofAction)
• the transactional API

Run a queue worker, or nothing is delivered. Every marketing mailable (MarketingMessageMailable, CampaignProofMailable, and TransactionalTemplateMailable) is pushed to the queue only after the surrounding database transaction commits, like Sales and Service mail, so mail queued inside a transaction that rolls back is never sent. The mail goes on your default queue connection and queue unless you set ODDEN_MARKETING_MAIL_CONNECTION and ODDEN_MARKETING_MAIL_QUEUE, and through your default mailer unless you set ODDEN_MARKETING_MAILER:

ODDEN_MARKETING_MAIL_QUEUE=marketing-mail
ODDEN_MARKETING_MAILER=ses

php artisan queue:work --queue=marketing-mail,default

With the sync queue connection, messages are sent as they're queued, inside the request or command. That works for development but not for a real list.

Scheduled commands#

The package registers five Artisan commands but doesn't schedule them. Add them to routes/console.php as shown in Installation.

Configuration#

Publish the config file to change any of these:

php artisan vendor:publish --tag=odden-marketing-config

See Transactional email for how the webhooks.* keys are used.

Routes#

Routes are registered in two groups whose attributes come from odden-marketing.routes.web and odden-marketing.routes.api. Empty values are dropped, so the default web group has no prefix and no domain. Configuration explains the shared route options.

If you set routes.enabled to false, register your own routes with the same names: models and emails build their links with route('odden.marketing.…').

web group#

These are the routes for the email side. The group also holds the hosted form, landing page, web tracking, NPS, and asset download routes, documented on their own pages.

api group#

Every route in this group is exempt from CSRF verification. The default prefix is api/marketing.

The API token#

Every route marked "API token" requires ODDEN_MARKETING_API_TOKEN:

ODDEN_MARKETING_API_TOKEN=a-long-random-string

Generate one with php -r 'echo bin2hex(random_bytes(32));'. Send it as Authorization: Bearer <token>, an X-Odden-Token header, or a ?token= query parameter.

The endpoints fail closed: while the token is empty they return 403, and a missing or wrong token returns 401. Configuration covers the token and the odden-public and odden-api rate limiters in detail.

Admin screens#

If you use the Filament plugin, it provides resources for campaigns and templates, a deliverability audit, proof sending, and a sender domain health page, all built on the classes these pages describe.