Blackbaud

Learn how to use Blackbaud with Composio

Overview

SLUG: BLACKBAUD

Description

Blackbaud offers cloud-based software for nonprofits, schools, and healthcare institutions, supporting fundraising, financial management, and donor engagement in mission-driven organizations

Authentication Details

client_id
stringRequired
client_secret
stringRequired
full
stringDefaults to https://app.blackbaud.com/Required
oauth_redirect_uri
stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add
scopes
stringDefaults to full
bearer_token
string

Connecting to Blackbaud

Create an auth config

Use the dashboard to create an auth config for the Blackbaud toolkit. This allows you to connect multiple Blackbaud accounts to Composio for agents to use.

1

Select App

Navigate to Blackbaud.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Blackbaud Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using OAuth2

1from composio import Composio
2
3# Replace these with your actual values
4blackbaud_auth_config_id = "ac_YOUR_BLACKBAUD_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000" # UUID from database/application
6
7composio = Composio()
8
9
10def authenticate_toolkit(user_id: str, auth_config_id: str):
11 connection_request = composio.connected_accounts.initiate(
12 user_id=user_id,
13 auth_config_id=auth_config_id,
14 )
15
16 print(
17 f"Visit this URL to authenticate Blackbaud: {connection_request.redirect_url}"
18 )
19
20 # This will wait for the auth flow to be completed
21 connection_request.wait_for_connection(timeout=15)
22 return connection_request.id
23
24
25connection_id = authenticate_toolkit(user_id, blackbaud_auth_config_id)
26
27# You can also verify the connection status using:
28connected_account = composio.connected_accounts.get(connection_id)
29print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Blackbaud toolkit’s playground

Python
1from composio import Composio
2from openai import OpenAI
3import json
4
5openai = OpenAI()
6composio = Composio()
7
8# User ID must be a valid UUID format
9user_id = "0000-0000-0000" # Replace with actual user UUID from your database
10
11tools = composio.tools.get(user_id=user_id, toolkits=["BLACKBAUD"])
12
13print("[!] Tools:")
14print(json.dumps(tools))
15
16def invoke_llm(task = "What can you do?"):
17 completion = openai.chat.completions.create(
18 model="gpt-4o",
19 messages=[
20 {
21 "role": "user",
22 "content": task, # Your task here!
23 },
24 ],
25 tools=tools,
26 )
27
28 # Handle Result from tool call
29 result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30 print(f"[!] Completion: {completion}")
31 print(f"[!] Tool call result: {result}")
32
33invoke_llm()

Tool List

Tool Name: Add Gifts To Batch

Description

Tool to add one or more gifts to a specified gift batch. Use when you need to append gifts to an existing open batch. Does not fail on non-2xx; returns response details for inspection.

Action Parameters

batch_id
stringRequired
gifts
arrayRequired

Action Response

data
error
string
raw
string
status_code
integerRequired
successful
booleanRequired

Tool Name: Get Gift By ID

Description

Tool to fetch a gift by its system record ID. Use when you need to retrieve full gift details from SKY API.

Action Parameters

gift_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Membership Details

Description

Tool to fetch detailed membership information. Use when you need to retrieve membership details by its junction ID.

Action Parameters

member_junction_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Payment Transaction

Description

Tool to fetch a payment transaction by its ID from SKY Payments API.

Action Parameters

transaction_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: OneRoster OAuth2 Base API

Description

Tool to interact with Blackbaud OneRoster OAuth2 base endpoints. Use to fetch OpenID configuration (/.well-known/openid-configuration), JWKS key set (publickeys), or obtain an access token via the client credentials grant. Ensure client credentials are configured before using the token operation.

Action Parameters

baseUrlOverride
string
basicAuth
string
clientId
string
clientSecret
string
grantType
stringDefaults to client_credentials
operation
stringDefaults to openid_configuration
scope
string

Action Response

data
objectRequired
error
string
successful
booleanRequired