Setting up Engaging Networks
mCommons supports Engaging Networks API. The Engaging Networks data sync allows for flexibility in sync type for new and updated records. The integration supports bidirectional synchronization of opt-in and opt-out data between mCommons and Engaging Networks, ensuring alignment of subscriber preferences across platforms.
Profiles are imported based on the Liberal Import setting configured in the integration:
-
When Liberal Import toggle is OFF: Only profiles that are opted in to the configured Opt-in Question are imported. Profiles that have not opted in are ignored.
-
When Liberal Import toggle is ON: All profiles are imported, regardless of their response to the Opt-in Question.
Encourage and Track Donations: You can review profiles that have made donations and track their contribution history over time. This allows you to create personalized messages that encourage ongoing donations and strengthen subscriber engagement.
Note: In all cases, the user records must include a listed mobile number. You must have Administrator access to work with data syncs in mCommons. For assistance, contact Technical Support.
To set up the Engaging Networks data sync:
Preparing for setup
Before you begin, gather the log-in credentials and set up any other key connection settings for your Engaging Networks CRM system. You must generate or fetch the API token associated with the API user created in your Engaging Networks account.
Configuring the Engaging Networks integration
To sync data between your Engaging Networks database and mCommons:
1. Select Home in the left pane, and then select Data Sync.
2. From the Integration Type drop-down list, select Engaging Networks.
3. Select Create.
The Engaging Networks configuration form opens.
For assistance, select Help next to the field label.
The Engaging Networks integration requires an API Token (not a traditional API key). You will need to provide:
-
API Host (your Engaging Networks instance URL, e.g., <https://ca.engagingnetworks.app>)
-
API Token (your private API token for authentication - this is used to generate session tokens)
-
And the provided public Mobilecommons IPs must be whitlisted in the Engaging Networks API user settings.
The system uses session-based authentication, so the API token is used to authenticate and obtain a session token, which is then used for API requests. A username or password is optional.
4. Web Opt-In Path: If you want new records coming from Engaging Networks to subscribe to a specific campaign, select a web opt-in path from the dropdown menu. If you do not select a web opt-in path, new records from Engaging Networks will remain unsubscribed in mCommons.
5.(Required) API Host: Enter the host name for API requests.
6.(Required) API Token: Enter the API token for your Engaging Networks account.
Note: You must have Super Admin access to create or manage tokens, and the API User permission. Navigation: Account Settings > Tokens.
You must generate or fetch the API token associated with the API user created in your Engaging Networks account. If an API user already exists, locate and use the corresponding API token.
Note: The minimum API token expiration time is 60 minutes.
The screenshot below displays the API user details, including the API key, whitelisted IPs, and other related user information. Please contact customer support for the mCommons IP addresses.
API Token Renewal: To continue making API calls after a token has expired, you must re-authenticate and obtain a new ens-auth-token. By default, this will be reauthenticated from mCommons, if expired.
-
API User Limit: 5,000 requests per hour per API user.
-
Page Processing Limit: 200 requests per 5 minutes from a single source IP address when dealing with page processing.
-
Token Invalidity: If the ens-auth-token is expired or otherwise invalid, subsequent API calls requiring authentication will fail, typically returning an "Invalid ens-auth-token" error.
7. Historical Query Name: Provide the query name for historical donations and profiles sync from your Engaging Networks account when configuring the integration.
8. Opt-In Question Name: Name of the opt in question created on Engaging Networks. Specify the opt-in question name (for example, “SMS Opt-In”) used in your Engaging Networks account to identify SMS subscriptions.
9. Liberal Import:
-
If Liberal sync is enabled, the data is synced in both directions, regardless of the opt-in status in Engaging Networks.
-
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 Engaging Networks system.
10. When you are done, select Update.
Logging in to Engaging Networks
After you set up your Engaging Networks integration, you can log in to Engaging Networks directly from mCommons.
To log in to Engaging Networks:
1. Select Home in the left pane, and then select Data Sync.
The home page for your Engaging Networks sync opens.
2. In the Integration Actions panel on the right, select Login to Engaging Networks.
The Engaging Networks page opens.
Field mappings
For field mappings, the dynamic mappings will be fetched from Engaging Networks API.
Adding new custom fields
For custom columns to sync both ways, you must first map the fields. Once mapped, these fields will be updated in the profiles and will also reflect on the Engaging Networks side if the fields are updated from mCommons (two-way sync). To map custom fields:
To map custom fields:
1. Go to Actions > Edit Field Mappings > CUSTOM FIELD.
2. Click + MAP CUSTOM FIELDS to add the required mappings.
The Add Custom Field modal will open, allowing you to add a map custom field. A Custom Integration Mapping is created with the API field name and custom field. This enables syncing of custom column values between the mapped custom columns from Engaging Networks to mCommons.
You can select from the list of available custom fields already created within your mCommons account. These are the fields you can map for your Engaging Networks CRM sync.
Note: Only one field can be selected at a time.
Once you choose a custom field from the dropdown, you will see additional input fields to complete the mapping:
• Field: Displays the name of the custom field.
• API Field Name: Shows the internal Engaging Networks API field name used for mapping.
• CSV Heading: Displays the name of the column in your imported CSV file that maps to the custom field.
• A Required checkbox (if the field must be populated during sync). A checkbox allows you to mark a custom field as required. Required fields must be included in the data during the integration process.
At the bottom of the modal, select CREATE to add the custom field to the custom field mappings table. This button will stay disabled until you select a valid field from the dropdown. Select CANCEL to close the modal without making any changes.
The Custom Field table displays all the custom fields you have added.
Custom fields are synced bidirectionally between Engaging Networks and mCommons. Changes in one are automatically reflected in the other.
In the CUSTOM FIELD tab, you can also use the search field to find entries (Field and API Field Name) by entering a complete or partial term.
Activating the Engaging Networks sync
Before you begin, review the configuration settings for your sync:
1. Select Home in the left pane, and then select Data Sync.
The home page for your Engaging Networks sync opens.
2. In the Integration Actions panel on the right, select Configure Integration.
3. Review the configuration settings, making adjustments as needed.
4. When you are done, select Update.
5. To activate the integration sync, in the Integration Actions panel on the right, select Activate Integration.
The indicator in the upper-right corner is Active.
Data sync updates
After activation, the mCommons data set and your Engaging Networks database are both updated twice a day on a regular basis.
Also, when user records are synced, the record number from the Engaging Networks system is added to the Constituent ID field in mCommons user profile and serves to identify records across both systems.
Note: During daily donations sync the data is exported only up to the last completed day, as data for the current day may still be processing in Engaging Networks bulk exports. It applies to bulk exports used in donations, while profile syncs continue to fetch up-to-date data.
Historical sync
By default, Engaging Networks allows you to export supporter and contributions data for up to 32 days in the past.
If you need to import older data, you can use the “Build Your Universe” feature in Engaging Networks. This feature lets you create a query to export all supporters.
To enable this, a new “Historical Query Name” field will be added in the integration setup. You will need to provide the query name for historical donation sync from your Engaging Networks account when configuring the integration.
Once the query name is saved, the system will use it to import all historical profiles and contributions beyond the 32-day limit.
Note: The historical sync runs only once after the integration is activated.
After your data sync runs, you can open the Synchronization report from the ACTIONS menu.
Viewing Synced Profiles in mCommons
When a profile is synced, you’ll see the “Imported from Engaging Networks” label for First Seen field and synchronization details within the Profile Details section.
Profile Header
• Profile for (Name): Shows the contact’s full name.
• Status: Displays current opt-in status: Active, Opted out, and others.
Profile Details Section
Field Description
-
Phone: The contact’s mobile number.
-
Email: The email address imported from the Engaging Networks CRM.
-
Full Name: The contact’s full name from the Engaging Networks CRM record.
-
Street / Address: Shows mailing address details, if available. If not present, it appears as Unknown.
-
Normalized Address: The address (street, city, state, and zip code) for the user.
-
Timezone: Indicates the time zone.
-
Created: Date and time when the profile was created in mCommons.
-
First Seen: Indicates the source — Imported from Engaging Networks.
-
Carrier: The mobile network provider (if detected). If not present, it appears as Unknown.
-
Supports MMS?: Shows whether the contact’s phone supports multimedia messages.
-
Supports Concat?: Indicates if the contact can receive multi-part (long) text messages.
Additional Engaging Networks CRM Synchronization Information
This section is key for synced profiles and shows integration details with Engaging Networks.
Field Description
-
Last Sync to Engaging Networks: Displays the last time data was successfully synchronized between mCommons and Engaging Networks.
-
Constituent ID: The unique record ID for the contact in Engaging Networks.
-
Record on Engaging Networks: Clickable link to view the corresponding record directly in Engaging Networks. When clicked on "Record on Engaging Networks" it takes to Engaging Networks website .
-
Pending Remote Update: Indicates if mCommons has unsynced data that still needs to be sent back to Engaging Networks (for example, 1 Pending Remote Update).
Deactivating the integration
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.