Information for: DEVELOPERS   PARTNERS

Onboarding: Configuration

Proper configuration is important for branding, performance, and the user experience for your team as they do their jobs. These settings are generally permanent after initial configuration.

System settings

General settings

Root URL

  • Mautic’s root URL: When a user signs in to their Campaign Studio instance, they go to customdomain.domain.com (the root URL). That page is accessible to the public. If a contact visits the root address, they see the Campaign Studio login page for the instance. Create a Campaign Studio landing page to greet contacts visiting your root URL.

    Once you’ve done that, users can sign in Campaign Studio by visiting https://customdomain.domain.com/s/login.

System defaults

Mautic configuration

  • Default item limit per page: The number of contacts, campaigns, emails, etc. which each page when you go to an item section. The default is 10.

  • Default time zone: The users’ default time zone, typically set to the time zone of the company headquarters. Time zones can be set for individual users. The default is UTC.

    For example: Headquarters is in Boston and the default is set to US Eastern Time (America New York). A user in San Francisco (US Pacific Time America Los Angeles) can display Pacific Time in the user interface.

  • Default language: The initial language assigned to users. Individual users may select their own settings. Campaign Studio uses English - United States by default.

  • Cached data timeout (minutes): Campaign Studio caches data to speed up page loads. Update this setting to change how long Campaign Studio caches the data. Campaign Studio uses 10 minutes as the default.

  • Date Range Filter Default: Sets the default for how far back from the current date Campaign Studio looks for data in reports (including campaign and email snapshots reports on the item page. If you’ve changed the setting on a report, Campaign Studio uses what you’ve entered. Campaign Studio’s default value is 1 Month.

  • Default format for full dates, date only, short dates, and time only: The defaults are set for standard US time format. See the PHP manual for date functions to change formats.

CORS settings

Cross-Origin Resource Sharing (CORS) enables data to pass between your website and Campaign Studio.

image3

  • Restrict Domains: When set to No, any web page can pass information to Campaign Studio. Select Yes to limit communication with your Campaign Studio instance to websites listed in Valid Domains.

  • Valid Domains: A list of domains allowed to communicate with your Campaign Studio instance. In the text box, list the exact URL of the top level domain you want to enable, one per line. For example: https://www.acquia.com tracks any activity on acquia.com pages, but http://www.acquia.com won’t because acquia.com is a secure website.

    Note

    In the Valid Domains field, don’t include a slash at the end. For example, use https://www.acquia.com instead of https://www.acquia.com/.

Miscellaneous settings

Miscellaneous Settings

  • IP lookup service: By default, Campaign Studio uses MaxMind GeoLite2 City to identify the city of a website visitor, based on the location of the Internet Service Provider (ISP) for their IP address.

  • IP lookup service authentication: To use another available IP lookup service, enter your credentials.

  • List of IPs not to track contacts with: To disable tracking for particular IP addresses, enter the addresses, one per line. Acquia doesn’t recommend adding your office IP address. If you list your internal IP address, Campaign Studio won’t track clicks, page hits, etc., from that IP, including testing clicks.

  • List of Bots to not track with: Campaign Studio has identified and disabled tracking for several known bots. To track activity from those bots, remove them from this list. To disable tracking for other bots, add them here (one per line).

  • URL Shortener: If you use a URL shortening service like bit.ly for links in SMS messages, enter your access token here. For bit.ly, use:

    https://api-ss..bitly.com/v3/shorten?access_token=[ACCESS_TOKEN]&format=txt&longUrl
    
  • Item max lock time: When a user edits a campaign, email, landing page, etc., Campaign Studio locks the item to prevent simultaneous edits by other users. When the initial user saves and closes or cancels out, the item may remain locked for this period of time. The default is 0 seconds.

Theme settings

theme settings

  • Default theme: Applies a theme to any form which doesn’t have a theme already applied. If you don’t have a landing page for your preference center, but have preference settings turned on in Email settings, Campaign Studio creates a default preference center page using the form styling from the theme selected here.

API settings

API Settings

Full API documentation is available here.

  • API enabled: Select Yes to pass data in and out of Campaign Studio through the API.

  • Enable HTTP basic auth?: Enables basic authentication for Campaign Studio’s API. Acquia recommends only using with secure sites (HTTPS).

  • Access token lifetime: When authorizing a new application or integration, limits how long the access token is valid (in minutes). The default is 60 minutes.

    For example: You add a new integration to your SaaS platform. Enter 30 here to limit the access token validity to 30 minutes. If you haven’t completed the authentication in that period of time, you must revalidate.

  • Refresh token lifetime: When using OAuth 2.0, the lifetime of the refresh token used to request a new access token once expired. Once the refresh token expires, you must reauthorize. The default is 14 days.

Campaign settings

Campaign Settings

  • Wait time before retrying a failed action: If for any reason a campaign action doesn’t execute, Campaign Studio waits the set length of time before trying again.

Email settings

Mail Send Settings

Email Settings - Mail Send Settings

  • Name to send mail as: The default name emails come from. This is typically something like {YourCompany} Marketing Team or {YourCompany}.

  • Email address to send mail from: The email address for the name you’re sending mail from. The address displays in the From: field when your contacts receive your emails.

    Ensure that you configure your sender domain, DKIM, bounce, and click tracking domains. For more information, see email domains document.

  • Mailer is owner: If contacts in Campaign Studio have Owners, select Yes to display the owner as sending all emails to the contacts they’re listed as the owner for. Mailer is owner overrides any other name or email to send mail from, including the default and individual emails. Every contact owner’s domain must have SPF and DKIM records. You can see this configuration for individual emails, rather than globally. See Mailer is owner.

  • Service to send mail through: For most Campaign Studio subscribers, this should remain set to Mautic. Your emails route through the Campaign Studio Sparkpost account. If you are sending through your own email service, select the service and enter your credentials. See Configuring your own email transport.

Default frequency rule

image9

  • Do not contact more than <number> each <period>: This limits the number of marketing messages a contact receives in a certain period of time (day, week, month). Transactional messages don’t count towards this limit. You can adjust this at the individual contact level, either manually or by preference center setting. For more information, see frequency rule.

Monitored inbox settings

image10

  • Default Mailbox: This inbox is where you receive bounce notifications from emails sent.
  • Contact Replies: Like the monitored inbox for bounces, Campaign Studio checks this inbox for contact replies. Configure this to use Replies to email decisions in any campaigns. If Use custom connection settings? is set to No, Campaign Studio checks the default mailbox. If set to Yes, you may track a different mailbox for replies.

Message Settings

Email Settings - Message Settings

  • Text for the {webview_text} token: The message indicating the reader can view the email in their browser. The default is:

      Having trouble reading this email? Click here.
    
    To change the text, change the message between the ``<a href="|URL|">`` and
    ``</a>`` tags. Don't change the ``|URL|`` text, because that is a token for
    each contact.
    
  • Default email signature: The signature for your default emails, which pairs with the name & email address in the Mail Send settings.
  • Append tracking pixel into email body?: To track email opens, select Yes. Select No to prevent tracking, reporting on, and using decisions based on email opens.
  • Convert embed images to Base64: Select Yes to display embedded images in emails as code rather than as images.
  • Disable trackable URLs: Removes tracking from URLs in your emails. Select Yes to prevent tracking, reporting on, and using decisions based on link clicks. Some email service providers don’t like redirecting URLs. Using trackable URLs in your emails may impact deliverability.

Form settings

Form Settings

Do not accept submission from these domain names: To block contacts with specific email domains from submitting your forms, enter those domains in the dialog box. Select an option on each form you want to apply this block to. You can restrict either specific email aliases that belong to a domain or an entire domain. To block the entire domain, you can use wildcards (*). For more information, see Blocking domains from submitting forms.

Segment settings

Segment Settings

  • Show warning if segment hasn’t been rebuilt for X hours: If segments aren’t rebuilt for the specified number of hours, Campaign Studio displays a warning message.

Landing page settings

Landing Page Settings

  • Show category in page URL?: If you use categories, the landing page’s associated category displays in the URL if you select Yes.
  • Analytics script: To track landing page visits and activity in other platforms such as Google Analytics, add those tracking scripts here.

Tracking settings

Campaign Studio tracking settings

Tracking Settings

Note

Pages including 4-byte UTF-8 characters (emojis, some Chinese or other non-Latin characters) in the page title or URL aren’t tracked on a contact’s activity history in Campaign Studio. All Latin characters (used in English and other western languages) are 1 byte and will track. The Campaign Studio team checks logs and alerts subscribers if they’re attempting to track pages with unsupported characters.

  • Tracking code: Insert this code on any page you would like to have tracked in Campaign Studio before the ending </body> tag.

    Note

    Tracking code changes after you set up or change a custom domain, and must be replaced. If you’re using the plugin for Wordpress, Drupal, or Joomla, re-enter your account information on the plugin.

  • Identify visitor by tracking URL: Select Yes to have Campaign Studio begin tracking a contact after the contact clicks a link in an email on a device where no cookie exists.

  • Anonymize IP: Select Yes to not store full IP addresses for your visitors/contacts. This setting aids customers in achieving GDPR compliance.

Facebook Pixel

Tracking Settings - Facebook Pixel

  • Facebook Pixel ID: Enter your Facebook Pixel ID and select the options you’d like to use the pixel for.
  • Enabled on your tracking page: Select Yes to have Campaign Studio append the Facebook Pixel to the Campaign Studio tracking code to track pages where the tracking code exists.
  • Enabled on Mautic landing page: Select Yes to have Campaign Studio add the Facebook Pixel to Campaign Studio landing pages.

Google Analytics

Tracking Settings - Google Analytics

  • Google Analytics ID: Enter your Google Analytics ID and select the options you’d like to use the pixel for.
  • Enabled on your tracking page: Select Yes to have Campaign Studio append the Google Analytics script to the Campaign Studio tracking code to track pages where the tracking code exists.
  • Enabled on Mautic landing page: Select Yes to have Campaign Studio add the Google Analytics script to Campaign Studio landing pages.
  • Enabled IP Anonymization: For subscribers sensitive to GDPR or other data privacy laws and regulations, select Yes to anonymize the IP address of web visitors before sending it to Google Analytics.

Report settings

Report Settings

  • Always quote data in CSV export: Select Yes to wrap each Campaign Studio field in double quotation marks when exported to a CSV file. For example: "First Name",``”Last Name”,””, ``"some text".

Text message settings

Text Message Settings

  • Select default transport to use: If you have configured a delivery service for SMS messages, select the service here to send messages. You must configure a delivery service before selecting it here.

User/Authentication settings

User/Authentication Settings

  • Identity provider metadata file: Upload the metadata XML file from your IDentity Provider (IDP) here.
  • Default role for created users: With user roles created in the Roles section of the settings panel, you may select one of those roles as the default for users created using SSO. If empty, Campaign Studio users won’t be created using SSO. See Onboarding: Users and Roles.

Enter the names of the attributes the configured IDP uses for the Campaign Studio user fields. Match the field name from your identity provider to the field name Campaign Studio uses for user creation.

  • Email
  • First name
  • Last name
  • Username

Use a custom X.509 certificate and private key to secure communication between Campaign Studio and the IDP. Upload your:

  • X.509 certificate
  • Private key file
  • Enter your Private key encryption password

Webhook settings

Webhook Settings

  • Order of the queued events: If several events are queued in a webhook, process the events in chronological or reverse chronological order.

Social settings

Social Settings

  • Twitter Handle Field: This field stores the Twitter username for users added to Campaign Studio through Social Monitoring.

Unsubscribe settings

Email Settings - Unsubscribe Settings

  • Text for the {unsubscribe_text} token: Like the {webview_text} token, customize the Unsubscribe link. For example:

    Edit between the <a href="|URL|"> and </a> tags. Don’t change the URL as it is tokenized. If you add {unsubscribe_url} as a token in the email, you won’t see this text.

  • Unsubscribed and resubscribed confirmation message: If a contact unsubscribes or resubscribes, this message displays on the page after the respective action. Don’t edit the |EMAIL| or the |URL| token in the <a href> tag.

  • Show contact preference settings: Select Yes to direct the unsubscribe link to your configured preference center. If you haven’t created a preference center, Campaign Studio creates a default page based on the next 5 settings. The created page uses the default theme for styling.

  • Show contact segment preferences: Select Yes to enable a contact to change which segments they’re part of on the preference center page. Segments won’t display on the preference center page if they aren’t published and public.

  • Show contact frequency preferences: Select Yes to enable an individual to limit the number of marketing messages they receive on each channel from the preference center.

  • Show pause contact preferences: Select Yes to enable contacts to disable messages from your Campaign Studio account to their email address for a specified date range. This action isn’t a full unsubscribe, and at the end of the date range the messages send to that address once again.

  • Show contact’s categories: If you have categories set for contacts, campaigns, emails, etc., select Yes to enable the contact to opt out of the categories they choose from the preference center page.

  • Show contact’s preferred channel option: If you have multiple channels available within your Campaign Studio account (email, SMS, mobile push, web notifications, etc.), contacts can choose their preferred channel. This can be useful if you are using Marketing Messages feature of Campaign Studio. For more information about the preference center, see Preference centers.