home

MinistryPlatform

RealmRealm AccountingMinistryPlatformGivingPDSACSConnectShepherdGrowth MethodHeadMasterRefresh WebsitesTrust CenterGo MethodMissionInsite
RealmRealm AccountingMinistryPlatformGivingPDSACSConnectShepherdGrowth MethodHeadMasterRefresh WebsitesTrust CenterGo MethodMissionInsite

What would you like to know more about?

Show Contents

Show Page Sections

thumbnailMinistryPlatform

Subscribe to Publication

Configuring Subscribe to Publication

Quick Start

The Subscribe to Publications Widget helps people sign up to receive a relevant publication! Check out the Quick Start Guide to get started.

If the shared script hasn't been added to your website, add it to the appropriate webpage, replacing "example-church.com" with the base URL of your church's website.

<script id="MPWidgets" src="https://example-church.com/widgets/dist/MPWidgets.js"></script>

Create a webpage on your website that will display your Subscribe to Publications Widget or identify the page on your website where it will be displayed.

Add the Subscribe to Publications Widget to your church website by placing this snippet of code in the body of your chosen webpage and modifying the required attributes. 

<mpp-subscribe-to-publication publicationid="5" returnurl="https://example-church.com/sample" verificationemailtemplateid="1200"></mpp-subscribe-to-publication>
Tip: While not mandatory, this snippet would typically be placed inside a <div> element with the class "container".

Widget Configuration

Required Attributes

  • Publication ID: Determines which Publication will be displayed.
    • Attribute: publicationid
    • Valid Value: Publication ID
    • Example: 
      publicationid="5"
  • Return URL: The URL the widget exists on. The verification email will use this to complete the subscription and display confirmation. For example, if you are placing this Widget on the page at "https://example-church.com/sample" you must use that as the returnurl.
    • Attribute: returnurl
    • Valid Value: fully qualified URL
    • Example: 
      returnurl="https://example-church.com/sample"
  • Verification Email Template: The email containing a verification link which will complete the subscription.
    • Attribute: verificationemailtemplateid
    • Valid Value: Message record ID (dp_Communications.Communication_ID)
      Note: The verification email comes from a Message, not a Message Template. Similar names but very different things.
    • Example: 
      verificationemailtemplateid="1200"

Attributes must be included before the opening widget tag is closed. Attributes may be listed in any order and should be separated by a space or other whitespace. An attribute's value should be wrapped in quotation marks.

Configure Your Widget

Fill out the Widget Configurator below, copy your generated widget code, and paste it into your website.

Platform Configuration

Publication: Any publication can be displayed in the Subscribe to Publication Widget, but each publication will require its own Widget.

  • Available Online set to True
  • Description: The Publication's description will be displayed above the subscribe form.

Messages: Messages sent by the Subscribe to Publication Widget are completely customizable. But to support the workflow, certain tokens must be incorporated into the Messages. See required and optional tokens for the three relevant messages.

  • Verification Email Template: Subscribe to Publication is a two-step Widget and this Message requires a verification token for visitors to continue the form. No records have been created for this user in the Platform, so Contact Merge Fields are not available. This Message can be personalized using optional tokens.
    • Required: Token [mpp_verify_email_url] should be set as the value of a link somewhere in this Message. This link should be set from source view. The link text displayed might be "click here" or "verify".
    • Optional: Tokens [mpp_contact_first_name] and [mpp_contact_last_name] will merge in the "First Name" and "Last Name" values provided on the form.
<div>please confirm your subscription by choosing <a href="[mpp_verify_email_url]">verify</a></div>
Note: To support the verification workflow, you will need to create your church's Verification Email Template, being sure to include the required token. Because this message will be sent to your people, we have not automatically added to your system.

Create a Verification Email Template

Widgets use Message IDs, not Template IDs. You can use the Template Editor Tool to create your Verification Email Template, but you will need to turn the Template into a Message and use that ID in the Subscribe to Publication Widget.
  1. Create and save your Verification Email Template using the Template Editor Tool. Make sure you'll be able to access the template.
  2. Open the New Message Tool and select your newly created template from the Template drop-down menu. Click Save as Draft.
  3. Navigate to Communications > Messages and find the draft you just created.
  4. Click the subject line to open the Message record. The Message ID will be listed underneath the subject line. Use this ID in the Verification Email Template ID attribute.

Customization

CSS: Every Widget accepts the Custom CSS attribute. Include it before the opening Widget tag is closed and customize backgrounds, button colors, and more.

Application Labels: Want to customize the filed labels on the Subscribe to Publication form? Or change the "Send" button to "Subscribe"? To make changes, go to System Setup > Application Labels and update the appropriate label(s). Note that you are responsible for all translations if the default is not used.

  • mpp-subscribe-to-publication.mobilePhoneLabel: The label above the phone number field. The default is "Mobile Phone."
  • mpp-subscribe-to-publication.subscriptionSuccessMessage: The message displayed then someone successfully subscribes. The default is "Thanks for subscribing!"
  • mpp-subscribe-to-publication.submitVerificationButtonText: The button label to subscribe to a publication. The default is "Send".
portal
MinistryPlatform

Last updated: November 26, 2024