Skip to main content

Campaign Monitor

The Campaign Monitor integration connects your audience in Allegro to your email program in Campaign Monitor. It subscribes members to lists and custom-field options when they sign in, keeps a copy of each member's subscriptions on their profile, and serves a preferences API your site can read and write.

FeatureWhat it does
Sign-in subscriptionsSubscribes a member to the connection's default lists and custom-field options when they sign in. Signing in never resubscribes someone who has unsubscribed.
Subscription syncKeeps a profile on each member holding the lists they're on and the custom-field options they've selected. Refreshed when they sign in and monthly while active.
Preferences APISession-authenticated endpoints your site or SDK uses to show members the lists and custom fields they can change, and to save their choices.
Custom-field optionsReads and sets a member's options on a Campaign Monitor multi-select or single-select custom field, such as an Interests field.

Turn on the Campaign Monitor package under Organization Settings → Packages first. The settings page then appears at Organization Settings → Campaign Monitor, and each property gets a Campaign Monitor page in its own settings.

One email provider at a time

Campaign Monitor and Salesforce Marketing Cloud both provide your organization's email program, so you can enable only one of them. The Packages page disables one while the other is on.

The settings page​

The organization page is a single form with three cards — Connection, Lists, and Custom fields. Save at the bottom saves the whole page at once, and Discard drops your unsaved changes.

Connect a Campaign Monitor account​

The Connection card holds the API key and client Allegro uses to read and update subscribers. Campaign Monitor uses an API key — there is no OAuth step.

  1. In Campaign Monitor, open Account settings → API keys and copy a key that can see the client you'll sync. An account-level key can list all of your clients; a client-level key works too, but you'll enter the client ID by hand.
  2. In Allegro, open Organization Settings → Campaign Monitor and paste the key into API key.
  3. Choose the Client whose lists this connection uses. With an account-level key you pick it from a list; with a client-level key you paste the client ID.
  4. Set Consent to track if you need to — Unchanged keeps the consent Campaign Monitor already has (and records none for a new subscriber), or choose Yes or No to send it with every subscribe.
  5. Click Save.

Allegro checks the key and client with Campaign Monitor before saving anything. If the key is rejected, can't see the client, or Campaign Monitor is unavailable, the error says so and nothing is saved.

The key is write-only: after saving, the field shows that a key is stored but never shows it again. Enter a new key to replace it, or click remove it to clear it on the next save. If Campaign Monitor can't be reached when the page loads, your saved lists are shown by ID and a status line explains why.

Choose lists​

The Lists card has four multi-selects. Each one is drawn from the client's lists in Campaign Monitor.

SettingWhat it does
Synced listsThe lists Allegro keeps on member profiles. Leave it empty to sync every list of the client.
Sign-in listsThe lists a member is subscribed to when they sign in, unless the sign-in names its own. Must be among the synced lists. Signing in never resubscribes an unsubscriber.
Preference listsThe lists members can subscribe to and unsubscribe from through the preferences API. Must be among the synced lists.
Exclusion listsPreference lists that opt a member out of something by including them — a fundraising-exclusion list, say. Leaving one removes the member from it instead of unsubscribing, so their other lists are untouched. An exclusion list can't also be a sign-in list.

Choose custom fields​

The Custom fields card maps Campaign Monitor's multi-select ("Select Many") and single-select ("Select One") custom fields — such as an Interests field — so members can be given options on them. Define the fields and their options in Campaign Monitor; Allegro reads and sets a member's options but never changes the field itself.

Click Add custom field for each one and fill in:

SettingWhat it does
ListThe synced list the field belongs to.
FieldThe custom field to manage.
Options on sign-inThe options set when a member signs in. For a single-select field you can choose one, and it's set only while the member has none — it never overrides their own choice.
Members can change this fieldExposes the field through the preferences API so members can set it themselves.
Date field to stampOptional. A date field on the same list that Allegro sets to the current time whenever a save leaves the option below selected.
When this option is selectedThe option that triggers the date stamp. Required once a date field is chosen.

Properties​

Each property chooses where its Campaign Monitor settings come from on its own Campaign Monitor settings page:

ModeWhat it does
InheritUses the organization's connection. This is the default, and shows a read-only summary of it.
CustomConnects the property to its own key, client, lists, and custom fields, with the same three cards.
OffSubscribes and syncs nothing for the property.

Changing a property's mode, its synced lists, or its custom fields starts a resync of the affected members.

The preferences API​

The preferences API lets your site show members the lists and custom fields they can change, and save their choices — a subscription center, in other words. It is authenticated with the member's Allegro session, like the rest of the Browser SDK, so your site reads and writes the signed-in member's own preferences.

A read returns the member's preference lists (each marked subscribed or not, and whether it's an exclusion list) and their changeable custom fields with the options available and currently selected. A write subscribes or unsubscribes lists and sets custom-field options; unsubscribing from an exclusion list removes the member from it. Only preference lists and fields marked changeable can be written, and the API is rate-limited per member.

Known gaps​

  • No webhooks. Allegro syncs a member on sign-in (when their profile is more than a week old) and monthly while they're active, so a change made directly in Campaign Monitor appears at the member's next sync, not immediately.
  • API key only. Campaign Monitor connects with an API key; there is no OAuth flow.
  • No segments or journeys. The integration manages list and custom-field subscriptions. It doesn't read Campaign Monitor segments or trigger journeys, and it has no data-extension or transactional-email features.