iMIS EMS Integration
This comprehensive guide walks you through the process of setting up the Message2Give integration within iMIS EMS. Designed for iMIS Technical Administrators, this documentation covers the essential steps to configure iMIS to leverage Message2Give's powerful engagement and communication toolkit.
Prerequisites
Before you begin, ensure you have:
- Administrative access to your iMIS EMS instance
- Message2Give API key (see Get Started guide)
- Permission to create custom panels and modify account pages
Step 1: Create IQA Queries
The Message2Give integration requires IQA (Intelligent Query Architect) queries to retrieve contact data for SMS campaigns and other operations. Each query must include at minimum a contact phone number column and a contact ID column.
Create a New Query
- Navigate to
RiSE>Intelligent Query Architect. - Choose an appropriate location (e.g., create a "Message2Give" folder).
- Click
New>Queryto create a new IQA query.
Configure Columns
Configure your query with the following required columns:
- Contact Phone Number: To send communications to.
- Contact ID: Unique identifier for correlation.
- Additional columns as needed (names, emails, etc.).
Test & Save
- Test your query to ensure it returns the expected results.
- Save your query with a descriptive name (e.g., "Active Members for SMS").
Enable REST API Access
Navigate to the Security tab and check Available via the REST API to enable Message2Give integration access.
Important
Don't forget to enable REST API access - this is critical for Message2Give integration functionality.
Note the Query Path:
After saving, take note of the query path (e.g., $/Message2Give/Active-Members). You will need this later.
Example query paths:
$/Message2Give/Active-Members
$/Message2Give/Event-Attendees
$/Custom-Queries/SMS-Campaign-ListYou can create as many queries as needed for different use cases (active members, event attendees, specific membership tiers, etc.).
Additional Resources
For detailed guidance on constructing IQA queries, refer to the iMIS IQA Building Queries Tutorials in the official iMIS documentation.
Step 2: Publish the Message2Give Page
To complete the integration, you'll need to embed the Message2Give application interface within your iMIS EMS instance. This involves creating a dedicated content folder, configuring the Message2Give app page, and adding it to your site navigation.
Create Message2Give Content Folder
- Navigate to
RiSE>Page Builder>Manage Content. - Create a new content folder by clicking
New>Website Content Folder. - Configure settings:
- Title:
Message2Give - Folder name:
Message2Give
- Title:
- Click
Saveto create the folder.
Create Message2Give App Page
- Navigate into the new
Message2Givefolder. - Create new content by clicking
New>Website Content. - Configure page settings:
- Title:
App - Publish file name:
App - Layout:
SingleColumn
- Title:
- Click
Add Contentto add content to this page. - Select
Content HTMLand clickOK. - Set an appropriate title for the HTML content (e.g., "Message2Give Application Interface").
- Click
Show EditororShow iMIS Editorto toggle to editor mode. - Paste the following HTML content into the text area editor:
<style>
#YabbrFrame {
display: block;
border: none;
height: 1000px !important;
width: 100% !important;
}
#ctl01_ContentPanel {
padding: 0px !important;
}
</style>
<iframe name="Message2Give" id="YabbrFrame" allow="clipboard-write" src="https://integrations.app.message2give.com"></iframe>
<script>
document.getElementById('YabbrFrame').addEventListener('load', function () {
// Each permission on a separate line in the array
const permissions = [
'read',
'write',
'delete'
];
const iframe = this;
// Post message to iframe
iframe.contentWindow.postMessage(permissions, 'https://integrations.app.message2give.com');
});
</script>- Click
OKto save the HTML content.
Configure Security
- Click on the
Propertiestab in the content editor. - Check Content requires user to log in.
- Click
Save & Publishto save and deploy the page. - Wait a moment and refresh the page to ensure the newly added website content is deployed.
Add to Site Navigation
Now that the Message2Give app page is created, add it to your site navigation to make it accessible to users.
- Navigate to
RiSE>Site Builder>Manage Sitemaps. - Click
New>Website Navigation Item. - Configure the navigation item:
- Link Text:
Message2Give - Content/URL:
@/Message2Give/App
- Link Text:
- Click
Saveto create the navigation item. - Click
Publishand thenOKin the confirmation dialog. - Close the dialog and refresh the page.
Verification
You should now see "Message2Give" in the sidebar. Clicking it should display "Welcome to Message2Give".
Step 3: Setup Message2Give App
After successfully embedding the Message2Give app in your iMIS EMS site, you need to complete the initial setup wizard to connect your data sources and configure the integration.
Welcome Screen
Click Get Started.
API Key Configuration
- Paste your Message2Give API key into the provided field (see Get Started).
- Click
Next.
iMIS Admin Credentials
- Enter the iMIS Username and Password (account with IQA permissions).
- Click
Next.
Data Sources Configuration
Add the IQA queries created in Step 1 as data sources for your Message2Give campaigns. You can configure parameters for your IQAs, allowing for dynamic data retrieval.
-
Click
Add Data SourceorAdd Newto open the configuration dialog. -
Enter Friendly Name (e.g., "Event Attendees") and IQA Path (e.g.,
$/Message2Give/Event-Attendees). -
Click
Load Parametersto retrieve parameters defined in your IQA. For each detected parameter, select the appropriate input type:-
Text / Date / DateTime: Standard input fields for filtering.
-
Select (Dropdown): Use this to restrict users to a predefined set of values defined by another IQA.
Select Options IQA Requirements
- Requires an Options IQA Path that returns Value and Label columns.
- The options IQA should not have any required parameters.
- Click
Fetch Optionsto validate.
-
-
Click
Addto save the data source.
Repeat this process for each IQA query you want to use as a data source.
Multiple Data Sources
You can add as many data sources as needed for your campaigns. Each data source corresponds to an IQA query you created in Step 1.
Complete Setup
Once all data sources have been configured, you can complete the setup process.
- Click
Finishto complete the initial setup. - Your integration is ready!
How is this guide?