What’s supported
Supported actions
This connector supports:- Read Actions, Please note pagination is not supported because the functionality of getting the next page is missed by the blackbaud engineering team. The team has acknowledged this gap and plans to address it in a future service pack release.
- Write Actions.
- Proxy Actions, using the base URL https://api.sky.blackbaud.com.
Supported Objects
The Blackbaud connector supports writing to and reading from the following objects:- crm-adnmg/batches (write)
- crm-adnmg/batches/revenue (write)
- crm-adnmg/batchtemplates (read)
- crm-adnmg/businessprocess/launch (write)
- crm-adnmg/businessprocessinstances (read)
- crm-adnmg/businessprocessparameterset (read)
- crm-adnmg/businessprocessstatus (read)
- crm-adnmg/currencies (read )
- crm-adnmg/notifications (write)
- crm-adnmg/sites (read)
- crm-conmg/addresses (write)
- crm-conmg/alternatelookupids (write)
- crm-conmg/constituentappeals (write)
- crm-conmg/constituentappealresponses (write)
- crm-conmg/constituentattributes (write)
- crm-conmg/constituentcorrespondencecode (write)
- crm-conmg/constituentnotes (write)
- crm-conmg/constituents (write)
- crm-conmg/educationalhistories (write)
- crm-conmg/emailaddresses (write)
- crm-conmg/fundraisers (write)
- crm-conmg/individuals (write)
- crm-conmg/interaction (write)
- crm-conmg/mergetwoconstituents (write)
- crm-conmg/organizations (write)
- crm-conmg/phones (write)
- crm-conmg/relationshipjobsinfo (write)
- crm-conmg/solicitcodes (write)
- crm-conmg/tribute (write)
- crm-evtmg/events (read, write)
- crm-evtmg/locations (read, write)
- crm-evtmg/registrants (read, write)
- crm-evtmg/registrationoptions (write)
- crm-evtmg/registrationtypes (read, write)
- crm-fndmg/designations/hierarchies (read)
- crm-fndmg/educationalhistory (read )
- crm-fndmg/fundraisingpurposes (read, write)
- crm-fndmg/fundraisingpurposerecipients (read, write)
- crm-fndmg/fundraisingpurposetypes (read)
- crm-mktmg/appeals (read, write)
- crm-mktmg/correspondencecodes (read, write)
- crm-mktmg/responsecategories (write)
- crm-mktmg/segments (write)
- crm-mktmg/segments/recordsources (read)
- crm-mktmg/solicitcodes (read)
- crm-prsmg/prospectcontactreports (write)
- crm-prsmg/prospectmanagers (read)
- crm-prsmg/prospectopportunities (read, write)
- crm-prsmg/prospectplans (write)
- crm-prsmg/prospects (read, write)
- crm-prsmg/prospectsconstituency (write)
- crm-prsmg/prospectsegmentations (write)
- crm-prsmg/prospectsteps (write)
- crm-prsmg/stewardshipplans (write)
- crm-prsmg/stewardshipplansteps (read, write)
- crm-revmg/payments (read, write)
- crm-revmg/recurringgifts (write)
- crm-revmg/revenuenotes (write)
- crm-revmg/revenuetransactions (read)
- crm-volmg/jobs (read, write)
- crm-volmg/occurrences (read, write)
- crm-volmg/volunteerassignments (read, write)
- crm-volmg/volunteers (read, write)
- crm-volmg/volunteerschedules (write)
Before You Get Started
To connect Blackbaud with Ampersand, you need a Blackbaud Account. Once your account is created, you’ll need to create an app in Blackbaud and obtain the following credentials from your app:- Application ID
- Application secret
Creating a Blackbaud App
Follow the steps below to create a Blackbaud app.- Log in to your Blackbaud account.
- After logging in, navigate to SKY API -> My account.
- Click My applications -> New application
- In the Application name field, enter the name of your application and provide additional details in the Application details section.
- In the Application website URL field, enter your website URL, then click Save.
- Under Settings, click Edit redirect URIs in the Redirect URIs section. Add the required redirect URIs and click Save.
-
Under Settings, click Edit scopes in the Scopes section. Select the required scopes and click Save.
Example integration
For an example manifest file of an Blackbaud integration, visit our samples repo on Github.Add Your Blackbaud App Info to Ampersand
- Log in to your Ampersand Dashboard.
-
Select the project where you want to create a Blackbaud integration.
- Select Provider Apps.
- Select Blackbaud from the Provider list.
-
Enter the previously obtained Application ID in the Client ID field, the Application Secret in the Client Secret field.
- Create a manifest file using the example.
- Deploy it using the amp CLI.
- If you are using Read Actions, create a destination.
- Embed the InstallIntegration UI component.
- Start using the connector!
- If your integration has Read Actions, you’ll start getting webhook messages.
- If your integration has Write Actions, you can start making API calls to our Write API.
- If your integration has Proxy Actions, you can start making Proxy API calls.