NGP Integration with Switchboard
- Benefits of Integrating with NGP, VAN, EveryAction
- Request API Key + App Name
- Add Your API Key and App Name to Switchboard
- Make your NGPVAN List Appear in Switchboard
- Import Your NGP, VAN, EveryAction List Into Switchboard
- Not Seeing Your List in the Above Step? Below are the Frequently Made Mistakes:
- Create and Sync Labels with NGPVAN
- FAQ: How Does Switchboard Data Appear In NGP/VAN?
- What to do if Your API Key Expires
Benefits of Integrating with NGP, VAN, EveryAction
By integrating with NGP, VAN, and/or EveryAction, you will be able to:
- Pull lists directly from your NGP account(s)
- Configure labels to take an action (apply an activist code, survey question, or canvass result) when it is applied to a contact
- If you have imported a contact at least once via the NGPVAN integration (which is how we know a VANID is associated with a phone number or email address), then we will automatically add a canvass response
TEXTED
(contact type "SMS Text") orCANVASSED
(contact type "Bulk Email") to the associated VANID when you text or email them using Switchboard.
Request API Key + App Name
To connect your NGPVAN account with Switchboard, you first need to request an API Key.
- Go to the Main Menu of your Account and search “API” in the Search box in the upper lefthand corner. Click on API Integrations, then click “Request an API Key.”
- When requesting the key, request it for “Leftapps Switchboard”, then select your support@ for NGPVAN, usually this is the state data director, but any email here can help you out!
- Once you request the API key via your account or email, you will have to wait for NGPVAN to get back to you. Either they will email you with the API Key information or the information will appear in the same part of your account where you requested it.
- Once you have the API key and app name, you can add it to your Switchboard account.
Add Your API Key and App Name to Switchboard
- Go to your Organization Settings in Switchboard.
- Click NGPVAN.
- To add a new key, click Add Key at the bottom of the page.
- Choose your database, and paste in your app name and API Key. Optionally, provide a description of your key. Then click Save.
- App name will typically look something like DNC.00001.leftapps
- API Key will typically be a long code with a lot of dashes.
Make your NGPVAN List Appear in Switchboard
After you connect NGPVAN to Switchboard, you have to give Switchboard access to the saved lists you want to appear in your Switchboard account.
- Log in to NGPVAN/Votebuilder – Go to the side of Votebuilder (MyCampaign or MyVoters) that you have an API key setup with Switchboard. Then, click on my folders:
- Find the folder you want to share with Switchboard and click into it.
- If you do NOT have a folder setup yet, you can create a new folder when saving the list:
- Click Edit Folder
- Scroll down to User Access. Find “API User, LeftApps NGP” under Users without Access. Click “API User, LeftApps NGP” (it will become highlighted blue) and click the “Add” button.
- This moves “API User, LeftApps NGP” to the column with Access. Make sure to click Save!
- Now any list you save in this folder will appear in Switchboard.
- Once you are ready to save your list in VAN, click Save List As.
- Select Saved List and then click Save.
- Name your list and save it into the same folder you shared to “API User, LeftApps NGP.”
- Now this list will be available for you in Switchboard!
Import Your NGP, VAN, EveryAction List Into Switchboard
After you've followed the above instructions to get your integration set up ✅ and to share your lists with Switchboard ✅, you can import your list from your NGP product into Switchboard and start texting those folks!
- Click the New Audience button from the Phone Audiences or Broadcast pages and then click Import from NGPVAN.
- This will open up a new window for you to select the list that you want to import into Switchboard.
- Once you've selected your list, click Create and Close, and it will take a few minutes to process. Please note that the larger your list, the longer it takes for the list to process.
Not Seeing Your List in the Above Step? Below are the Frequently Made Mistakes:
- You saved your list as a saved search not a saved list.
- In order for NGPVAN to be able to import the list to Switchboard, you must save your list as a static saved list in the NGPVAN side.
- Your integration is for a different tool.
- Switchboard offers multiple integrations to NGP products within one account but you must add each individual API Key and App name to Switchboard in order for that works. That includes adding an integration for the MyCampaign side and MyVoters side of Votebuilder separately!
- You did not share the folder to the Switchboard API.
- Go back to the section Make your NGPVAN List Appear in Switchboard to make sure this is done correctly!
- Still not seeing your list? Email support@oneswitchboard.com and we will help you troubleshoot!
Create and Sync Labels with NGPVAN
Labels can be used to tag contacts with information. For example, you may use Grassroots Donor to tag contacts that give under $100 to your organization. You can then use these labels in various parts of Switchboard. On the Phone List Page, you can create a new phone list that includes/excludes contacts with specific labels. On the Message Threads Page, you can filter contacts to just those with specific labels.
If your NGPVAN/Votebuilder account is connected to Switchboard, you can configure a label to take an action (apply an activist code, survey question, or canvass result) when it is applied to a contact.
Create a New Label
- From the Messaging Home Page, click Labels.
- Click Add Label.
- A new window will pop up. Name your label and click Submit when you are done.
Create Action to Sync Label with NGPVAN
- After you have created a label, click on the label you want to add an action to.
- Under Update Actions, you can choose to apply an activist code, apply a survey question, or apply a canvass result.
- After you select the action you’d like to take, another drop down will populate where you can pick which specific activist code/survey response/ canvass response you’d like to take. See examples below:v
- After you select the action, moving forward, the contacts you apply these labels to in Switchboard will get the associated action in NGPVAN within about 10-20 minutes after you apply the label. If you apply the label by accident and remove it immediately, it will not sync to NGPVAN.
FAQ: How Does Switchboard Data Appear In NGP/VAN?
What does Switchboard need to send data automatically to my NGP/VAN accounts?
In order for Switchboard to automatically send data back to your NGP/VAN accounts, you need to have set up the NGP integration in Switchboard AND imported a list directly from NGP/VAN of the phone numbers you want to have data sent back to. You cannot just upload a CSV file with VAN IDs attached in order for Switchboard to send data back to NGP. The phone number and VAN ID must be imported directly from an NGP list import via the NGP integration in order for data to sync from Switchboard back to NGP.
When I text someone in Switchboard, how does that show up in NGP/VAN?
When you send a text to a phone number, we automatically log a canvass response with the type SMS_TEXT
and result TEXTED
to ALL VAN IDs mapped to that phone number in Switchboard. Depending the volume of traffic on both Switchboard and NGP, you can expect that to show up in NGP VAN within an hour or two.
If I have more than one NGP/VAN committee connected to one Switchboard account, how does the text sent map to NGP/VAN?
A phone number in Switchboard can be associated with multiple NGP/VAN IDs when imported from multiple NGP/VAN committees. Switchboard tracks phone numbers first and then what van IDs are connected and the source of where the number came from (ie. Switchboard MyVoters - GOTV List). If you import a phone number from two different committees, that phone number will have two mappings; one for each NGP/VAN instance.
When a number is texted, we will automatically apply the canvass response with the type SMS_TEXT
and result TEXTED
to ALL VAN IDs mapped to that phone number in Switchboard. This means, if you have several committees connected (ie. Switchboard MyVoters and Switchboard MyCampaign) and you have imported a phone number via both committees, when you text them in Switchboard, they will be marked with the canvass response type SMS_TEXT
and result TEXTED
in the MyVoters and MyCampaign side.
If I have more than one NGP/VAN committee connected to one Switchboard account, how does label data map back to NGP/VAN?
When mapping a label back to NGP/VAN, you choose which key/integration the action is associated with:
We will only map this data back based off what is set in the action. It takes about 10-20 minutes for this data to be sent back to NGP/VAN from Switchboard. So, if you imported a phone number from MyVoters and MyCampaign, but a label is only associated with a Survey Question from MyCampaign, we will only send that Survey Question data back to MyCampaign.
When someone opts out from my texts in Switchboard, how does that show up in my NGP/VAN?
Every Switchboard account has a system created "Opted Out" label that is applied to anyone who opts out from your Switchboard program. You can create an action associated with that label the same way you do with your other labels. You can set one or more actions - if you have multiple NGP committees integrated with one Switchboard account it is helpful to send this data back to all committees. See example:
Remember, in order for this data to sync back to your NGP/ VAN committees automatically:
- You need to have set up an NGP/VAN integration in Switchboard.
- You need to have imported the phone number + VAN ID directly to Switchboard via importing a list directly from NGP/VAN of the phone numbers you want to have data sent back to. You cannot just upload a CSV file with VAN IDs attached in order for Switchboard to send data back to NGP.
- You need to have set up the action BEFORE the person opted out.
What to do if Your API Key Expires
- Request a new API key from NGPVAN: Go to the Main Menu of your Account and search “API” in the Search box in the upper lefthand corner. Click on API Integrations, then click “Request an API Key.” Once you request the API key via your account or email, you will have to wait for NGPVAN to get back to you. They will either email you the API Key information or the information will appear in the same part of your account where you requested it. Once you have the new API key and app name, you can add it to your Switchboard account.
- Next, you can go into your Switchboard account. Click the top left corner > Organization Settings.
- Click into the NGPVAN tab and scroll down to your current NGPVAN key. Next, click Disable.
- Click Disable again to confirm this decision in the pop up window.
- You will then add your new key as usual.