Blackbaud On Integration: Setup and Deployment Process

The Blackbaud On integration is created and configured by Finalsite, with critical input from you. It allows information that’s stored in your school’s On database to be used on your website. Integration also allows users to login to your site using their Blackbaud username and password (rather than needing a separate password for the website).

This article outlines the process for establishing a Blackbaud On integration, including what information Finalsite needs from school staff.

Deployment process

We can begin working on an integration between your website and your school’s Blackbaud database after the integration added to your contract. Blackbaud On rollouts will follow this general plan, with modifications as needed to address the specific needs of individual schools.

  1. Your school will grant Finalsite access to the On API for your organization. To do this, Finalsite will need from you:

    • The URL for your instance of On (e.g.

    • A user created in On with a first name of “Finalsite”, a last name of “User”, and a username of “finalsiteuser”. This is the account Blackbaud will grant API access to when we request it.

    • The name(s) of the primary data contact(s) at your organization.

  2. An Integration Specialist from Finalsite Support will setup a time to speak with you about the integration, and to get a sense of what the desired mapping should be. (“Mapping” involves correlating data fields in Blackbaud with data fields in Finalsite in order to determine exactly which pieces of information about each user are brought over, and where they’re stored in Finalsite.)

    This mapping is very flexible, so please inform your integration specialist of your preferred mapping for roles between On and Finalsite.

    We utilize the same endpoint (Users) for all Constituent feeds, but the data can be mapped independently for each role (Students, Faculty & Staff, Parents, etc.) as different behaviors may be desired for different constituent groups. This is a typical example of how roles are mapped from On to Finalsite:

    On Role(s) Finalsite Role
    Teacher, Non-Teaching Staff Faculty & Staff
    Parent Parent
    Student Student
    Alumni Alumni

    We map some of the data by default; data that’s not included in the default mapping is available for custom mappings.

    Can we get admissions data from On?  We are able to target any role that exists in On, so if there are admissions users in On we can target them and have access to the same demographic, contact, and relationship data as any other "user" role.  However, we don't have any access to specific admissions data (e.g. status of application, grade applying for, etc.) so it may not serve all your needs/wants to pull that data into Finalsite.  If you are interested in pulling these roles, we recommend discussing it with your Client Success Manager to ensure it suits your needs and is implemented properly. 

    Note: Because there is not a correlating "households" data-point we are able to utilize in the data provided by the On API, we cannot set the feed to set Households in Finalsite. This is most important if you are using the Carpool element in Composer, which is based on households being set in Finalsite. If you want to use the On integration AND the Carpool element, you will need to manage household data manually in Finalsite.

  3. After we determine the details for the mapping with you, Support will create a clone of your site on which to test the integration and refine the mapping until it matches what was discussed initially.

    If you’re already using live data (i.e., you have data in Constituent Manager but will be adding an integration for the first time), your Integration Specialist will discuss needed steps for a smooth deployment on your site, including data cleanup and constituent ID rekeying.

  4. Support will reach out to the school contact so that they can review the resulting data and make any desired changes to the integration. After the integration is completed, refined and tested, Support will provide you with a complete explanation of the final mapping detailing how your integration works.

  5. You and your Integration Specialist will determine when the integration will go live. Support will migrate the integration to your live site and run it at the agreed-upon time, and we’ll provide schools with any information they need for maintaining it on an ongoing basis.

    When activated, the integration will be set for hourly data synchronization. Support will monitor and provide feedback on the first few runs to ensure everything is working as expected.

  6. The integration deployment will be marked as “completed” after the synchronization is running without any issues. After that point, any modifications to the mapping or reports of issues with the integration should be submitted to the Finalsite Support team.

Was this article helpful?
1 out of 1 found this helpful



Please Sign in to leave a comment if you don't see the comment box below.