Setting up EveryAction

Mobile Commons supports EveryAction API v4.

The EveryAction data sync allows for flexibility in sync type for new and updated records. User records must include a listed mobile number and the Country field setting must be US:

  • If Liberal sync is enabled, the data is synced in both directions, regardless of the opt-in status in EveryAction.

  • If Liberal sync is not enabled (Conservative sync), the data is updated only for those records with an opt-in status of true in your EveryAction system.

    For information on selecting the data sync type, see Configuring the EveryAction Integration.

Note: You must have Administrator access to work with data syncs in Mobile Commons. For assistance, contact Technical Support.

To set up the EveryAction data sync:

Preparing for setup

Before you begin, gather the log-in credentials and set up any other key connection settings for your EveryAction CRM system.

  1. In Mobile Commons, create or designate a web opt-in path, which will serve as the default opt-in path for any new users pulled from the EveryAction data set. For more information, see Adding a new web opt-in path.

    New subscribers will receive the Welcome message associated with the selected opt-in path. For more information, see Data sync paths.

  2. Make a note of the existing EveryAction login or API user name (email address) and password.

    Tip: Create a new set of credentials exclusively for use with Mobile Commons (recommended).

    Note: Work with your EveryAction representative to set up a new API user, with Superuser status.

  3. Make a note of the API host name, which is usually the URL of your EveryAction account.

Configuring the EveryAction integration

To sync data between your EveryAction database and Mobile Commons:

  1. Select Home Home in the left pane, and then select Data Sync.

  2. From the Integration Type drop-down list, select EveryAction.

  3. Select Create.

    The EveryAction configuration form opens.

    Action Network configuration form

    For assistance, select Help Help next to the field label.

  4. In the Login field, enter your user name for your EveryAction system, and then enter your password in the Password field.

  5. (Optional) If users from EveryAction will opt-in to your campaign via a web path opt-in, select the Mobile Commons web opt-in path from the drop-down list. All mobile users from EveryAction will receive opt-in messages from the opt-in path you specify.

  6. Enter the host name for API requests.

  7. Select the type of data sync:

    • Select On to enable Liberal data sync: sync data in both directions, regardless of the opt-in status.

    • Select Off to disable Liberal data sync (Conservative sync): sync data only for those records with an opt-in status of true in your EveryAction system.

  8. (Optional) Enter your notes for internal use only.

  9. When you are done, select Update.

Reviewing required and supported fields

The EveryAction data sync supports all standard profile fields; it does not sync custom fields. After you configure your EveryAction integration with Mobile Commons, review your EveryAction system and Mobile Commons user records (profiles) to ensure required and supported fields are available in both data sets.

The following fields are required:

  • Phone number

  • Email

  • Opt-in status

Category Field

Default field name

(The field names differ by data set)
Subscription status Opt-in (required)

  • "opt_in_status" (Mobile Commons)

  • "mobile opt-in" (EveryAction)
Demographic Phone number (required)

  • "phone_number" (Mobile Commons)

  • "mobile_phone" (EveryAction)
  First name

  • "profile_first_name" (Mobile Commons)

  • "given_name" (EveryAction)
  Last name

  • "profile_last_name" (Mobile Commons)

  • "family_name" (EveryAction)
  Email (required)

  • "profile_email" (Mobile Commons)

  • "email" (EveryAction)
Address/Location Street address

  • "address_street_1" (Mobile Commons)

  • "address!" (EveryAction)
  Street address 2

  • "address_street_2" (Mobile Commons)

  • "address2" (EveryAction)
  City

  • "address_city" (Mobile Commons)

  • "locality" (EveryAction)
  State

  • "state" (Mobile Commons)

  • "region" (EveryAction)
  Zip Code

  • "address_postal_code" (Mobile Commons)

  • "postal_code" (EveryAction)
  Country

  • "address_country" (Mobile Commons)

  • "country" (EveryAction)
Other

Identifier

  • "Constituent ID" Mobile Commons)

  • "id" (EveryAction) Mobile Commons)

Use custom field mappings to specify field names in EveryAction.

To set up custom field mappings:

  1. Select Home Home in the left pane, and then select Data Sync.

    The home page for your EveryAction sync opens.

  2. In the Integration Actions panel on the right, select Edit Field Mappings.

    Field mapping

  3. Review the field names to ensure that they are correct.

    • The Field column contains the Mobile Commons field name.

    • The API Field Name column contains the API field name in EveryAction.

  4. To limit the sync to records that contain data in specific fields, select the Required? checkbox next to the field name. When a field is required, it must contain a value in order to be synced. Empty fields are not synced.

    Caution: Do not select Required for Phone number, Email, or Opt-in status fields, which must by default exist in both databases in order to sync data. Use caution if you change the field name for any of these three fields; if the custom field name is incorrect, the data sync will fail.

    Caution: Do not select Required for Constituent as this ID is provided by EveryAction. If it is set to Required, Mobile Commons profiles will not have this ID, causing the sync from Mobile Commons to EveryAction to fail.

  5. When you are done, select Save.

Activating the EveryAction sync

Before you begin, review the configuration settings for your sync:

  1. Select Home Home in the left pane, and then select Data Sync.

    The home page for your EveryAction sync opens.

  2. In the Integration Actions panel on the right, select Edit Configure Integration.

  3. Review the configuration settings, making adjustments as needed.

  4. When you are done, select Update.

  5. To activate the EveryAction integration sync, in the Integration Actions panel on the right, select Activate Activate Integration.

    The indicator in the upper-right corner is Active Active. The first data sync will run the following morning.

    Note: When syncing records, Mobile Commons pushes records to EveryAction to add the identifier to the profile, which will keep both records in sync. Mobile Commons can match a record based on the mobile phone number and acquires the email address from EveryAction.

Data sync updates

After activation, the Mobile Commons data set and your EveryAction database are both updated on a regular basis:

  • Mobile Commons checks for updates nightly, processing all recent updates from EveryAction during overnight hours or updates to any of the supported fields within the past 48 hours.

  • Any new opt-ins or opt-outs from Mobile Commons are synced to EveryAction  every five minutes during the day.

    • For users whose profile records contain an email address, new opt-ins are added to EveryAction as a new record with an opt-in status of true.

    • For users with a matching record in EveryAction, new opt-outs update their opt-in status to false.

    Note: Once user records are synced, the record number from the EveryAction system is added to the Constituent ID field in Mobile Commons user profile and serves to identify records across both of your systems.

After your data sync runs, you can open the Synchronization report. For more information, see Working with the Synchronization report.

Tip: If you need to shut off the data sync with your CRM system, whether temporarily or permanently, you can deactivate it. For more information, see Deactivating the integration.