Version 2.2 - July 22, 2020

Before starting the integration, you must take the following steps on Luminate Online:

  • Set up a Boolean custom field named: Phone2Action Text Opt In to store Phone2Action's mobile communications (text) opt-in status 

  • Create your API key, API user name and API password on Luminate Online. In addition, you must enter an IP address from where the API requests will originate. The API key, user name and password are all set up within the Luminate Online system, specifically under Setup > Site Options > Open API Configuration.

  • Click Configure API Keys for the API Key

  • Click edit server API Configuration to set the user name and password. You must enter the following IP address: on the same screen.

  • Please note that your API user name must able to create groups on Luminate Online. Please check with your Luminate Online technical support team if you have questions about this setting. 

Other items to consider:

  • If title is a mandatory field or you have customized titles in your Luminate Online site, please contact us at so we can ensure the title field is working correctly. 

  • If you would like to use Capitol Canary advocacy activity in your engagement factors on Luminate Online, please contact us at so we can ensure this is properly set up. 

Capitol Canary Setup

The integration process can now begin on Capitol Canary. Under Organization - Settings - Integrations, click Connect for Luminate Online to reach the setup screen. 

While there are tooltips on this screen, here is some additional background:

  • Short name - Your organization's name in Luminate Online URLs. It appears after "" 

  • Cluster - The text that precedes "" in Luminate Online URLs. This is typically secure2, secure3 or something unique to your organization if you have a white labeled site.

  • If using a custom secure domain (aka white label) for Luminate Online, you should enter the URL for the site instead of the short name and cluster combination.

  • Security Category - This is necessary only if using security categories in your Luminate Online site. Enter the security category that maps to the Capitol Canary account - e.g. if constituents from New Jersey are in a security category with id=27, then enter 27 when setting up the integration for the Capitol Canary New Jersey account.

  • Enter the API Key, API User Name and Password that were set up on Luminate Online. 

You can then configure how data will flow between Capitol Canary and Luminate Online.

  • The “Overwrite existing Luminate Online data when the constituent joins a Capitol Canary campaign” checkbox will control whether name,  address, phone number and custom field information is updated on Luminate Online if the constituent provides different information when taking action on Capitol Canary . This is not enabled (checked) by default.  Please note that the primary email address and email-opt in fields are never updated from Capitol Canary after the constituent has been created. 

  • The “Make Phone2Action tags become groups on Luminate Online” determines if any tags applied to Capitol Canary advocates are automatically created as Luminate Online groups. This is not enabled (checked) by default.

Click continue to advance to the page where you can Match custom fields and Kick Off the sync. 

You can map Capitol Canary custom fields to Luminate Online custom fields by clicking the “Match Custom Fields” button. You are shown a listing of Capitol Canary custom fields, and can choose which field should be copied over to Luminate Online custom fields for an advocate. Please make sure that you are mapping fields appropriately. We do not recommend mapping to  Boolean custom fields on Luminate Online.

Once custom field mapping is completed, you can click the Kick Off sync button to begin the process of data flowing from Capitol Canary to Luminate Online. Your integration should now be working.

Data Sync

The following information is synced:

  • Capitol Canary advocates to Luminate Online Constituents

  • Capitol Canary campaigns to Luminate Online Groups

  • Capitol Canary tags to Luminate Online Groups (this is optional)

Advocate Sync: Capitol Canary takes all email addresses for an advocate and matches them against the email addresses of Luminate Online constituents. If no match is found, a new constituent record is created. Otherwise, the constituent record is updated. When constituents are created, the source on Luminate Online will be Capitol Canary and the subsource will be the name of the first campaign that the advocate has joined. 

If multiple constituents have the same email address, Capitol Canary will create a new constituent for that email address. These constituents can be easily identified because they will be in a group named: "Phone2Action Duplicates." This is a common scenario if using Luminate Online TeamRaiser.

Names, physical address (street, city, state, zip code) and email address are synced. In addition, the opt-in status for email and text communications is synced. Once a primary email address is created, Capitol Canary will not change it, nor will it change the email opt-in status. Custom fields that have been mapped are also synced on the advocate record. 

Constituent data will be changed on Luminate Online only if the “Overwrite existing Luminate Online data when the constituent joins a Phone2Action campaign” checkbox has been checked. If a field is empty on Luminate Online, Capitol Canary will always update it.

Please be aware that the integration may increase the total number of Luminate Online constituents, which could affect your organization's pricing plan. Please consult with your Blackbaud account representative should you have any questions.

Campaign Sync & Groups: All campaigns that an advocate has joined or taken action on will be created as groups and the Luminate Online constituent will be associated with that group. Note that the group name will consist of the campaign name, campaign id and some indication of the type of campaign. For “Contact My Legislators” campaigns on Capitol Canary, we will create a group for each type of contact and as well as a group for the overall campaign. So, if a Capitol Canary customer has a campaign named “End Daylight Savings Time” for advocates to email or tweet elected officials, these three groups would be created. 

  • End Daylight Savings Time (632549) - Capitol Canary Email

  • End Daylight Savings Time (632549) - Capitol Canary Twitter

  • End Daylight Savings Time (632549) - Capitol Canary Legislator Contact

Only one group will be created for other campaign types. Here is an example for a petition campaign:

  • End Daylight Savings Time (617212) - Capitol Canary Sign a Petition

Note that if an advocate becomes a Luminate Online constituent via Capitol Canary (meaning there was no constituent record prior to running the integration), then the person will be associated with a group named “Source: Phone2Action”.  Customers can use this group to exclude any Capitol Canary-acquired advocates from welcome series emails sent from Luminate Online. In addition, all advocates that sync over from Capitol Canary will be in the group: Phone2Action Advocates.

Groups will be created for all campaigns that Capitol Canary customers have joined or taken action on prior to the sync being started, and any campaigns joined after the sync has started. If security categories have been set up, the groups will be associated with them. 

Interactions: When clients take action or join campaigns, Capitol Canary will send information to Luminate Online about the type of interaction and the date it occurred. Luminate Online can take these interactions and have them populate engagement factors. For example, you could set up an engagement factor so it looks for constituents who have sent emails to legislators from Capitol Canary. This will update daily and you can query Luminate Online to find constituents who, for example, have sent more than five emails in the past year.

Tag Sync: If the client chooses to have Capitol Canary tags become Luminate Online groups, all tags will become groups. This includes tags that have been applied prior to the sync being started, and those tags added after the sync has started. 

Checking Your Integration

After the kickoff completes, here are a few quick ways you can check how the data has synced from Capitol Canary to Luminate Online:

  • Search for all your constituents that synced over from Capitol Canary in the group "Phone2Action Advocates"

  • Look for those constituents opted in to mobile communications by searching the "Phone2Action Text Opt In" custom field

  • Look for a group created from one of your recent campaigns. Those that took action should be part of the group.

Miscellaneous Notes 

  • The Luminate Online system does its own matching of constituent records to legislative districts. In rare cases, this may be different than the legislative districts assigned to advocates on the Capitol Canary platform.

  • Zip code information may be different as well in rare cases, as Luminate Online looks at address information and does its own geocoding. 

  • If a campaign name is changed after one advocate has joined or taken action, we can not update the group name on Luminate Online. This is why we included the campaign ID in the group name, so there is always a link with the Capitol Canary campaign. 

Did this answer your question?