Blackbaud Raisers Edge NXT

Provides integration with Blackbaud Raisers Edge NXT through template-driven SKY API read and mutation operations.

Revision History

0.0.0.8 - Initial V2 release with 344 supported non-preview Blackbaud SKY API operations.

Connection

Use this Connection to store the Blackbaud OAuth and subscription-key settings used by all methods.

Property Type Description
Client ID String OAuth client identifier issued by Blackbaud.
Client Secret Masked OAuth client secret issued by Blackbaud.
Refresh Token Masked Refresh token issued through the Blackbaud authorization-code flow.
API Subscription Key Masked Blackbaud SKY API subscription key sent in the Bb-Api-Subscription-Key header.
Access Token Masked Runtime-managed OAuth access token.
Access Token Expires At UTC DateTime Runtime-managed UTC expiry of the cached access token.

Setup Notes

  • Create a Blackbaud SKY application and obtain its OAuth Client ID, Client Secret, refresh token, and API subscription key.
  • Enter the refresh token in the Connection. This Node does not use client-credentials authentication.
  • Run the Connection test to validate the credentials against Blackbaud.
  • The embedded templates do not require a live provider request, but runtime operations require a complete Connection.

Methods

The Node groups supported operations into Query, Create, Update, and Delete methods. Select a template so Flowgear supplies the matching OperationId, Options, and request-body contract.

Query

Executes a supported Raisers Edge NXT read operation.

Parameter Type Description
Connection Connection Blackbaud OAuth Connection.
OperationId String Supported operation key selected by the template.
Options Object Structured path, query, and operation-specific header values.
Return Type Description
Response Array Provider-shaped Blackbaud rows. Collection responses emit one row per item and are paged internally.

Create

Executes a supported Raisers Edge NXT POST operation.

Parameter Type Description
Connection Connection Blackbaud OAuth Connection.
OperationId String Supported operation key selected by the template.
Options Object Structured path, query, and operation-specific header values.
Items Array Complete request-body items for body-requiring operations.
Return Type Description
Response Array One normalized mutation row per request body, or one row for a supported bodyless POST action.

Update

Executes a supported Raisers Edge NXT PATCH or PUT operation.

Parameter Type Description
Connection Connection Blackbaud OAuth Connection.
OperationId String Supported operation key selected by the template.
Options Object Structured path, query, and operation-specific header values.
Items Array Complete request-body items for the selected update.
Return Type Description
Response Array One normalized mutation row per request body.

Delete

Executes a supported Raisers Edge NXT DELETE operation.

Parameter Type Description
Connection Connection Blackbaud OAuth Connection.
OperationId String Supported operation key selected by the template.
Options Object Structured path, query, and operation-specific header values.
Return Type Description
Response Array One normalized delete response row.

Usage Notes

  • Templates come from 13 embedded Blackbaud SKY OpenAPI documents and expose 344 captured non-preview operations.
  • Path and query values appear directly under Options. Operation-specific headers appear under Options.Headers.
  • Query completes the first provider request while the invoke is awaited and fetches later pages only as the Workflow consumes the response.
  • Create and Update process one Items object per provider request. Supported bodyless POST operations run once from Options without consuming Items.
  • Mutation rows include Flowgear.IsSuccess, Flowgear.Message, and Flowgear.Request. Query rows remain provider-shaped.
  • Successful token refreshes persist the access token, expiry, and any rotated refresh token to the Connection.

Known Issues

  • Preview operations and APIs outside the embedded OpenAPI snapshot are not exposed.
  • Live behavior for some provider 403, 409, 412, 429, and partial gift-batch responses depends on Blackbaud and may require environment-specific handling.