Compartir por

Almabase (Preview)

  • Reference

Almabase is world's most loved alumni management software to build alumni-centric programs to increase participation, donor engagement, and host engaging online communities.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Almabase Support
URL https://docs.almabase.com
Email help@almabase.com
Connector Metadata
Publisher Almabase, Inc.
Website https://almabase.com
Privacy policy https://www.almabase.com/ecloud-privacy-policy
Categories Sales and CRM;Productivity

Almabase provides software tools & strategies for educational institutions to build alumni-centric programs that turn unengaged alumni into supporters for life.

This connector is built on top of Almabase APIs & Webhooks and provides operations to help manage entities found within Almabase, including:

  • Record (Constituents)
  • Gifts
  • Events
  • Engagement Touchpoints
  • Forms
  • Funds
  • Giving Pages
  • Peer to Peer Fundraising Campaigns
  • and more...

Prerequisites

To use this connector,

  • You must have an active Almabase Subscription.
  • You must have the site admin role.

How to get credentials

  • Login to your Admin Portal provided by Almabase.
  • Navigate to API's & Tokens under Settings.
  • Click on Add Auth Token, and fill in the description, and set the token expiry date & time.
  • Note down the Workflow Access Token (click on the token to copy on the clipboard).
  • Use the Workflow Access Token when creating the new connection on Power Automate.

Get started with your connector

Common Use cases

  • When a gift is made, send a personalized message & gift receipt.
  • When an engagement activity is recorded on Slack, Gmail, or any other social media, add the engagement activity to Engagement Studio on Almabase using Create Custom Touchpoint action.
  • When a new email address is found (lost alumni) in a Gift or an event registration or a form submission, add that email address to a record on Almabase or a Constituent on Raiser's Edge or a Contact on Salesforce.
  • Design bi-directional data sync between Almabase and Blackbaud Raiser's Edge.
  • Design bi-directional data sync between Almabase and Salesforce.

Known issues and limitations

  • Gift triggers work only when the online payment is made on Almabase. Manually added Gifts would not trigger the flows.

Creating a connection

The connector supports the following authentication types:
Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
Domain URL string Specify your Almabase domain url e.g. https://your.domain.com True
API Key securestring The API Key of the user True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Add a contact person

Adds a contact person to an event.
Create a fund

Creates a new fund.
Create a gift

Creates a new gift.
Create a record

Creates a new record.
Create a touchpoint

Send a new custom touchpoint to Almabase.
Create an email address for a record

Creates a new email address for a record.
Create an event

Creates a new event.
Delete an email address of a record

Delete an email address of a record.
Get a fund

Returns information about a fund.
Get a gift

Returns information about a gift.
Get a giving page

Returns information about a giving page.
Get a record

Returns information about a record.
Get a submission of a form

Returns information about a form submission.
Get an email address of a record

Returns information about an email address of a record.
Get an event

Returns information about a event.
List Contact Persons

Returns a list of all the contact persons on an event.
List email addresses of a record

Returns a list of email addresses for a record.
List Events

Returns a list of all the events.
List forms

Get a list of forms.
List funds

Returns a list of funds
List gifts

Returns a list of gifts.
List giving pages

Returns a list of giving pages.
List records

Returns a list of records.
Submit a form

Creates a new form submission for a form
Update a contact person

Updates a contact person on an event.
Update a fund

Updates a fund.
Update a gift

Updates a gift
Update a record

Updates a record.
Update an email address of a record

Updates the fields the email address of a record
Update an event

Updates an event.

Add a contact person

Operation ID:
AddEventContactPerson

Adds a contact person to an event.

Parameters

Name Key Required Type Description
Event ID
 id True integer

System generated ID to uniquely identify an event.
Email
 email email

Email of the contact person
Name
 name string

Name of the contact person
Phone Number
 phone_number string

Phone number of the contact person

Returns

Contact person of an event

Body
v1.EventApi.ContactPersonRead

Create a fund

Operation ID:
CreateFund

Creates a new fund.

Parameters

Name Key Required Type Description
External Database ID
 external_database_id string

A system assigned unique ID for the fund by the external database. e.g. System Record ID for Raiser Edge NXT, Object Id for Salesforce
Is default fund?
 is_default boolean

Indicates to associated all the splits to this fund if no other funds are defined on Giving Page.
Is Other Fund?
 is_other_fund boolean

Indicates that the donors of this fund have given custom fund name.
Fund Name
 name True string

Name of the fund

Returns

The fund associated with the gift split.

Fund
v1.GivingApi.FundRead

Create a gift

Operation ID:
CreateGift

Creates a new gift.

Parameters

Name Key Required Type Description
Gift Amount
 amount True string

The gift amount with two decimals.
Batch Number
 batch_number string

The batch number of the gift.
Gift Date
 completed_at True date-time

The date when the status of the gift is marked as completed.
Currency
 currency True integer

Currency used by the donor for the gift.
Donor Address: Line 1
 donor_address_line1 string

The address line 1 used by the donor for the gift.
Donor Address: Line 2
 donor_address_line2 string

The address line 2 used by the donor for the gift.
Name: City, State, Country
 name string

The city of of the donor. Format: City Name, Short State Name, Short Country Name
Donor Email
 donor_email True email

Email ID used by the donor for the gift.
Donor Name
 donor_name True string

Full name of the donor.
Donor Phone Number
 donor_phone_number string

Phone Number used by the donor for the gift.
Donor Address: Zip Code
 donor_zip_code string

The zip code of the address used by the donor for the gift.
Is hidden from Leaderboard?
 exclude_from_leaderboard boolean

Is hidden from Leaderboard?
External Database ID
 external_database_id string

A system assigned unique ID for the gift by the external database.
Tribute Message
 honor_message string

A message for a gift tribute.
Tribute Prefix
 honor_prefix string

A prefix for a gift tribute. Available options are in_honor_of, in_memory_of, in_support_of
Is Anonymous?
 is_anonymous boolean

Indicates the wish of donor be be anonymous to other donors for this gift.
Mode of Payment
 mode True string

Mode of Payment, either online or offline.
Note
 note string

The note text.
Other Fund Name
 other_fund_name string

When the donor selects a fund that's marked as is_other_fund, they add a custom fund name to attribute the gift.
Giving Page
 id integer

System generated ID to uniquely identify a giving page.
ID
 id integer

System generated ID to uniquely identify a record.
Amount
 amount True string

The amount of the gift split.
Fund
 id True integer

System generated ID to uniquely identify a fund.
Status
 status True string

Status of the gift.

Returns

Gift

Body
v1.GivingApi.GiftRead

Create a record

Operation ID:
CreateRecord

Creates a new record.

Parameters

Name Key Required Type Description
Line 1
 line1 True string

Line 1 of the Address
Line 2
 line2 string

Line 2 of the Address
Name
 name string

City,State,Country of the Location
Privacy
 privacy string

privacy
Type
 type True string

Type of the number
Zipcode
 zip_code string

Zipcode of the Address
Date of Birth
 date_of_birth string

Date of birth.
Deceased
 deceased boolean

Deceased.
Address
 address email

The email address
Use for Login?
 is_login_email boolean

Indicates if the user are allowed to login to the Platform using this email address.
Is Primary?
 is_primary boolean

A primary email is used to send the automated emails triggered by the System. It is also used to send the bulk email to the profile. It's mandatory that only one email is set as primary.
Source
 source string

The source indicate how the email is added to the database.
Status
 status string

Status of the email address
Type
 type string

The type of the email
External Database ID
 external_database_id string

A system assigned unique ID for the record by the external database. e.g. System Record ID for Raiser Edge NXT, Contact Id for Salesforce
External Database Lookup ID
 external_database_lookup_id string

A custom user-defined lookup ID for the record in the external database. e.g. Constituent ID
First Name
 first_name True string

First name of the record.
Last Name
 last_name True string

Last name of the record.
Middle Name
 middle_name string

Middle name of the record.
Number
 number True string

Number
Privacy
 privacy string

privacy
Type
 type True string

Type of the number

Returns

record

Body
v1.RecordApi.RecordRead

Create a touchpoint

Operation ID:
createTouchpointCustomObject

Send a new custom touchpoint to Almabase.

Parameters

Name Key Required Type Description
Program
 touchpoint_program True integer

Filters the types by touchpoint programs.
Email
 email email

Email ID used for the activity.
ID
 id integer

System generated ID to uniquely identify a record.
Recorded At
 recorded_at True date-time

The timestamp of the activity.
Type
 id True integer

Returns

Touchpoint body to create a new touchpoint

Body
v1.AlmasightsApi.TouchpointCustomObjectAdd

Create an email address for a record

Operation ID:
CreateRecordEmailAddress

Creates a new email address for a record.

Parameters

Name Key Required Type Description
Record ID
 record_id True integer

System generated ID to uniquely identify a record.
Address
 address email

The email address
Use for Login?
 is_login_email boolean

Indicates if the user are allowed to login to the Platform using this email address.
Is Primary?
 is_primary boolean

A primary email is used to send the automated emails triggered by the System. It is also used to send the bulk email to the profile. It's mandatory that only one email is set as primary.
Source
 source string

The source indicate how the email is added to the database.
Status
 status string

Status of the email address
Type
 type string

The type of the email

Returns

Email Address

Body
v1.RecordApi.EmailAddressRead

Create an event

Operation ID:
CreateEvent

Creates a new event.

Parameters

Name Key Required Type Description
Description
 description string

Description of the event
End Time
 end_datetime string

End time of the event
External Database ID
 external_database_id string

A system assigned unique ID for the record by the external database. e.g. System Record ID for Raiser Edge NXT, Contact Id for Salesforce
External Registration Url
 external_registration_url string

The registration url of the event on an external website
Name
 name True string

Name of the event
Start Time
 start_datetime string

Start time of the event
Timezone
 timezone string

Timezone of the event
Name
 display_name string

City,State,Country of the Venue

Returns

Event

Body
v1.EventApi.EventRead

Delete an email address of a record

Operation ID:
DeleteRecordEmailAddress

Delete an email address of a record.

Parameters

Name Key Required Type Description
Record ID
 record_id True integer

System generated ID to uniquely identify a record.
ID
 email_id True integer

System generated ID to uniquely identify a email address of a record.

Get a fund

Operation ID:
GetFund

Returns information about a fund.

Parameters

Name Key Required Type Description
Fund ID
 id True integer

System generated ID to uniquely identify a fund.
Fields
 fields array

The comma seperated list of fields in the response.

Returns

The fund associated with the gift split.

Fund
v1.GivingApi.FundRead

Get a gift

Operation ID:
GetGift

Returns information about a gift.

Parameters

Name Key Required Type Description
Gift ID
 id True integer

System generated ID to uniquely identify a gift.
Fields
 fields array

The comma seperated list of fields in the response.

Returns

Gift

Body
v1.GivingApi.GiftRead

Get a giving page

Operation ID:
GetGivingPage

Returns information about a giving page.

Parameters

Name Key Required Type Description
Giving Page ID
 id True integer

System generated ID to uniquely identify a giving page.
Fields
 fields array

The comma seperated list of fields in the response.

Returns

Giving Page

Body
v1.GivingApi.GivingPageRead

Get a record

Operation ID:
GetRecord

Returns information about a record.

Parameters

Name Key Required Type Description
Record ID
 id True integer

System generated ID to uniquely identify a record.
Fields
 fields array

The comma seperated list of fields in the response.

Returns

record

Body
v1.RecordApi.RecordRead

Get a submission of a form

Operation ID:
GetFormEntry

Returns information about a form submission.

Parameters

Name Key Required Type Description
Form
 form_id True integer

System generated ID to uniquely identify a form.
Response ID
 entry_id True string

System generated ID to uniquely identify a form submission.

Returns

The outputs of this operation are dynamic.

Get an email address of a record

Operation ID:
GetRecordEmailAddress

Returns information about an email address of a record.

Parameters

Name Key Required Type Description
Record ID
 record_id True integer

System generated ID to uniquely identify a record.
ID
 email_id True integer

System generated ID to uniquely identify a email address of a record.

Returns

Email Address

Body
v1.RecordApi.EmailAddressRead

Get an event

Operation ID:
GetEvent

Returns information about a event.

Parameters

Name Key Required Type Description
Event ID
 id True integer

System generated ID to uniquely identify a event.
Fields
 fields array

The comma seperated list of fields in the response.

Returns

Event

Body
v1.EventApi.EventRead

List Contact Persons

Operation ID:
ListEventContactPersons

Returns a list of all the contact persons on an event.

Parameters

Name Key Required Type Description
Event ID
 id True integer

System generated ID to uniquely identify an event.

Returns

response
array of v1.EventApi.ContactPersonRead

List email addresses of a record

Operation ID:
ListRecordEmailAddresses

Returns a list of email addresses for a record.

Parameters

Name Key Required Type Description
Record ID
 record_id True integer

System generated ID to uniquely identify a record.
Is Primary?
 is_primary boolean

Search for primary email.
Fields
 fields array

The comma seperated list of fields in the response.
Page Size
 page_size integer

Represents the number of records to return. The default is 10. The maximum is 50.
Page Number
 page integer

Represent the page numbers (offset). For use with pagination.

Returns

Name Path Type Description
Next results URL
 nextlink uri

URL for the next page set of results. For use with pagination.
Previous results URL
 previouslink uri

URL for the previous set of results. For use with pagination.
Total Email Addresses
 total integer

Total email addresses for the given filters
Email Address
 value array of v1.RecordApi.EmailAddressRead

List of email address of a record returned for the given filters. The results are paginated.

List Events

Operation ID:
ListEvents

Returns a list of all the events.

Parameters

Name Key Required Type Description
Search By External Database Id
 external_database_id string

Search for events by external database ID.
Fields
 fields array

The comma seperated list of fields in the response.

Returns

response
array of v1.EventApi.EventRead

List forms

Operation ID:
ListForms

Get a list of forms.

Parameters

Name Key Required Type Description
Fields
 fields array

The comma seperated list of fields in the response.

Returns

response
array of v1.FormApi.FormRead

List funds

Operation ID:
ListFunds

Returns a list of funds

Parameters

Name Key Required Type Description
Fields
 fields array

The comma seperated list of fields in the response.

Returns

response
array of v1.GivingApi.FundRead

List gifts

Operation ID:
ListGifts

Returns a list of gifts.

Parameters

Name Key Required Type Description
Status
 status True string

Filter gifts based on the status.
Giving Page
 campaign integer

System generated ID to uniquely identify a giving page.
Filter By Gift Group Id
 group_id uuid

System generated ID to uniquely identify a gift group or a list.
Should have empty batch number?
 batch_number__isnull boolean

Filter gifts based on they have a batch number or not.
Should have empty external database id?
 external_database_id__isnull boolean

Filter gifts based on they have already have external database Id or not. NOTE: The Gifts that have external database id, are already pushed to external database.
Filter by External Database Id
 external_database_id string

Filter gifts based on external database id.
Filter by Donor Email
 donor_email string

Filter gifts based on donor email address
Search By
 search string

Search for gifts by name or email address.
Fields
 fields array

The comma seperated list of fields in the response.
Page Size
 page_size integer

Represents the number of records to return. The default is 10. The maximum is 50.
Page Number
 page integer

Represent the page numbers (offset). For use with pagination.
Order by
 ordering string

Define the order of the gifts in the response. A "-" prefix represent descending order, and absence of the prefix would return the results in ascending order.

Returns

Name Path Type Description
Next results URL
 nextlink uri

URL for the next page set of results. For use with pagination.
Previous results URL
 previouslink uri

URL for the previous set of results. For use with pagination.
Total Gifts
 total integer

Total gifts for the given filters
Gifts
 value array of v1.GivingApi.GiftRead

List of gifts returned for the given filters. The results are paginated.

List giving pages

Operation ID:
ListGivingPages

Returns a list of giving pages.

Parameters

Name Key Required Type Description
Fields
 fields array

The comma seperated list of fields in the response.

Returns

response
array of v1.GivingApi.GivingPageRead

List records

Operation ID:
ListRecords

Returns a list of records.

Parameters

Name Key Required Type Description
Search By Name
 search string

Search for records by name.
Search By Email Address
 email_addresses__address string

Search for records by email address.
Search By External Database Id
 external_database_id string

Search for records by external database ID.
Fields
 fields array

The comma seperated list of fields in the response.
Updated on or after
 updated_at__gte date-time

Updated on or after a date.
Created on or after
 created_at__gte date-time

Created on or after a date.
Page Size
 page_size integer

Represents the number of records to return. The default is 10. The maximum is 50.
Page Number
 page integer

Represent the page numbers (offset). For use with pagination.

Returns

Name Path Type Description
Next results URL
 nextlink uri

URL for the next page set of results. For use with pagination.
Previous results URL
 previouslink uri

URL for the previous set of results. For use with pagination.
Total Records
 total integer

Total records for the given filters
Records
 value array of v1.RecordApi.RecordRead

List of records of a record returned for the given filters.

Submit a form

Operation ID:
CreateFormEntry

Creates a new form submission for a form

Parameters

Name Key Required Type Description
Form
 form_id True integer

System generated ID to uniquely identify a form.
body
 body dynamic

Create a new form submission

Returns

Name Path Type Description
Response ID
 id integer

System generated ID to uniquely identify a form submission.

Update a contact person

Operation ID:
UpdateEventContactPerson

Updates a contact person on an event.

Parameters

Name Key Required Type Description
Event ID
 id True integer

System generated ID to uniquely identify an event.
Event Contact Person Id
 person_id True integer

System generated ID to uniquely identify a contact person on an event.
Email
 email email

Email of the contact person
Name
 name string

Name of the contact person
Phone Number
 phone_number string

Phone number of the contact person

Returns

Contact person of an event

Body
v1.EventApi.ContactPersonRead

Update a fund

Operation ID:
UpdateFund

Updates a fund.

Parameters

Name Key Required Type Description
Fund ID
 id True integer

System generated ID to uniquely identify a fund.
External Database ID
 external_database_id string

A system assigned unique ID for the fund by the external database. e.g. System Record ID for Raiser Edge NXT, Object Id for Salesforce
Is default fund?
 is_default boolean

Indicates to associated all the splits to this fund if no other funds are defined on Giving Page.
Is Other Fund?
 is_other_fund boolean

Indicates that the donors of this fund have given custom fund name.
Fund Name
 name True string

Name of the fund

Returns

The fund associated with the gift split.

Fund
v1.GivingApi.FundRead

Update a gift

Operation ID:
UpdateGift

Updates a gift

Parameters

Name Key Required Type Description
Gift ID
 id True integer

System generated ID to uniquely identify a gift.
Batch Number
 batch_number string

The batch number of the gift.
Donor Address: Line 1
 donor_address_line1 string

The address line 1 used by the donor for the gift.
Donor Address: Line 2
 donor_address_line2 string

The address line 2 used by the donor for the gift.
Name: City, State, Country
 name string

The city of of the donor. Format: City Name, Short State Name, Short Country Name
Donor Name
 donor_name string

Full name of the donor.
Donor Phone Number
 donor_phone_number string

Phone Number used by the donor for the gift.
Donor Address: Zip Code
 donor_zip_code string

The zip code of the address used by the donor for the gift.
Is hidden from Leaderboard?
 exclude_from_leaderboard boolean

Is hidden from Leaderboard?
External Database ID
 external_database_id string

A system assigned unique ID for the gift by the external database.
Tribute Message
 honor_message string

A message for a gift tribute.
Tribute Prefix
 honor_prefix string

A prefix for a gift tribute. Available options are in_honor_of, in_memory_of, in_support_of
Is Anonymous?
 is_anonymous boolean

Indicates the wish of donor be be anonymous to other donors for this gift.
Note
 note string

The note text.
Other Fund Name
 other_fund_name string

When the donor selects a fund that's marked as is_other_fund, they add a custom fund name to attribute the gift.
Giving Page
 id integer

System generated ID to uniquely identify a giving page.
ID
 id integer

System generated ID to uniquely identify a record.
Amount
 amount True string

The amount of the gift split.
Fund
 id True integer

System generated ID to uniquely identify a fund.

Returns

Gift

Body
v1.GivingApi.GiftRead

Update a record

Operation ID:
UpdateRecord

Updates a record.

Parameters

Name Key Required Type Description
Record ID
 id True integer

System generated ID to uniquely identify a record.
External Database ID
 external_database_id string

A system assigned unique ID for the record by the external database. e.g. System Record ID for Raiser Edge NXT, Contact Id for Salesforce
External Database Lookup ID
 external_database_lookup_id string

A custom user-defined lookup ID for the record in the external database. e.g. Constituent ID
First Name
 first_name string

First name of the record.
Last Name
 last_name string

Last name of the record.

Returns

record

Body
v1.RecordApi.RecordRead

Update an email address of a record

Operation ID:
UpdateRecordEmailAddress

Updates the fields the email address of a record

Parameters

Name Key Required Type Description
Record ID
 record_id True integer

System generated ID to uniquely identify a record.
Email Address ID
 email_id True integer

System generated ID to uniquely identify a email address of a record.
Use for Login?
 is_login_email boolean

Indicates if the user are allowed to login to the Platform using this email address.
Is Primary?
 is_primary boolean

A primary email is used to send the automated emails triggered by the System. It is also used to send the bulk email to the profile. It's mandatory that only one email is set as primary.
Status
 status string

Status of the email address
Type
 type string

The type of the email

Returns

Email Address

Body
v1.RecordApi.EmailAddressRead

Update an event

Operation ID:
UpdateEvent

Updates an event.

Parameters

Name Key Required Type Description
Event ID
 id True integer

System generated ID to uniquely identify an event.
Description
 description string

Description of the event
End Time
 end_datetime string

End time of the event
External Database ID
 external_database_id string

A system assigned unique ID for the record by the external database. e.g. System Record ID for Raiser Edge NXT, Contact Id for Salesforce
External Registration Url
 external_registration_url string

The registration url of the event on an external website
Name
 name string

Name of the event
Start Time
 start_datetime string

Start time of the event
Timezone
 timezone string

Timezone of the event
Name
 display_name string

City,State,Country of the Venue

Returns

Event

Body
v1.EventApi.EventRead

Triggers

When a form is submitted or an existing form submission is updated

Triggers when a form is submitted or an existing form submission is updated.
When a new gift is successful or an online gift payment is failed

Triggers when a new gift is successfully recorded on a Giving Page by a donor or the payment to a gift is failed.
When an email is created, updated or deleted on a record

Triggers when a new email is created on a record or an existing email is updated or deleted from a record.
When an record is created or updated on Almabase

Triggers when a new record is created on Almabase or an existing record is updated.

When a form is submitted or an existing form submission is updated

Operation ID:
FormEntryCreateOrUpdateWebhook

Triggers when a form is submitted or an existing form submission is updated.

Parameters

Name Key Required Type Description
When
 events True string

The list of events to trigger the flow.
Form
 object_id True integer

System generated ID to uniquely identify a form.

Returns

The outputs of this operation are dynamic.

When a new gift is successful or an online gift payment is failed

Operation ID:
GiftSucceededOrFailedWebhook

Triggers when a new gift is successfully recorded on a Giving Page by a donor or the payment to a gift is failed.

Parameters

Name Key Required Type Description
When
 events True string

The list of events to trigger the flow.
Giving Page
 object_id integer

System generated ID to uniquely identify a giving page.

Returns

Body
v1.GivingApi.GiftWebhookResponse

When an email is created, updated or deleted on a record

Operation ID:
EmailChangedWebhook

Triggers when a new email is created on a record or an existing email is updated or deleted from a record.

Parameters

Name Key Required Type Description
When
 events True string

The list of events to trigger the flow.

Returns

Body
v1.RecordApi.EmailWebhookResponse

When an record is created or updated on Almabase

Operation ID:
RecordChangedWebhook

Triggers when a new record is created on Almabase or an existing record is updated.

Parameters

Name Key Required Type Description
When
 events True string

The list of events to trigger the flow.

Returns

Body
v1.RecordApi.RecordWebhookResponse

Definitions

v1.FormApi.FormRead

Form

Name Path Type Description
ID
 id integer

System generated ID to uniquely identify a form.
Form Name
 title string

The name of the form

v1.GivingApi.GiftWebhookRecordRead

Record

Name Path Type Description
External Database ID
 external_database_id string

A system assigned unique ID for the record by the external database. e.g. System Record ID for Raiser Edge NXT, Contact Id for Salesforce
First Name
 first_name string

First name of the mapped record
ID
 id integer

System generated ID to uniquely identify a record.
Is Donor Registered on Almabase?
 is_registered boolean

Indicate if the mapped record or donor registered on Almabase
Last Name
 last_name string

Last name of the mapped record

v1.GivingApi.GiftWebhookResponse

Name Path Type Description
Amount
 data.amount string

The gift amount with two decimals.
Date
 data.completed_at date-time

The date when the status of the gift is marked as completed.
Donor Email
 data.email email

Email ID used by the donor for the gift.
External Database ID
 data.external_database_id string

A system assigned unique ID for the gift by the external database.
ID
 data.id integer

System generated ID to uniquely identify a gift.
Is New Email?
 data.is_email_new boolean

Indicates if the email provided by donor already exists on Almabase records.
schema
 data.mapped_profile.schema v1.GivingApi.GiftWebhookRecordRead

Record
Mode
 data.mode string

Mode of the gift.
Donor Name
 data.name string

Full name of the donor.
ID
 data.page.id integer

System generated ID to uniquely identify a giving page.
Giving Page Name
 data.page.name string

Name of the associated giving page
Status
 data.status string

Status of the gift.
Event Triggered At
 time string

The event time.
Event Type
 type string

The event type.

v1.GivingApi.LocationRead

The city used by the donor for the gift.

Name Path Type Description
City
 city string

The city of the donor
City Short Name
 city_short_name string

The short representation of the City, e.g. SF
Latitude
 coordinates.latitude string

The latitude of the location
Longitude
 coordinates.longitude string

The longitude of the location
Country
 country string

The country of the donor
Country Short Name
 country_short_name string

The short representation of the country, e.g. US
Google Place Id
 gpid string

The place id obtained from Google
City, State, Country
 name string

The city of of the donor. Format: City Name, Short State Name, Short Country Name
State
 state string

The state of the donor
State Short Name
 state_short_name string

The short representation of the state, e.g. CA

v1.GivingApi.FormFieldRead

Form Field

Name Path Type Description
Value
 display_value string

The formatted value entered by responders. e.g. Name of the File Upload.
Question/Form Field Name
 label string

The question/form field name on the form

v1.GivingApi.FundRead

The fund associated with the gift split.

Name Path Type Description
External Database ID
 external_database_id string

A system assigned unique ID for the fund by the external database. e.g. System Record ID for Raiser Edge NXT, Object Id for Salesforce
ID
 id integer

System generated ID to uniquely identify a fund.
Is default fund?
 is_default boolean

Indicates to associated all the splits to this fund if no other funds are defined on Giving Page.
Is Other Fund?
 is_other_fund boolean

Indicates that the donors of this fund have given custom fund name.
Name
 name string

Name of the fund

v1.GivingApi.GiftRead

Gift

Name Path Type Description
Gift Amount
 amount string

The gift amount with two decimals.
Batch Number
 batch_number string

The batch number of the gift.
Gift Date
 completed_at date-time

The date when the status of the gift is marked as completed.
Currency
 currency integer

Currency used by the donor for the gift.
Device
 device string

Identify the device used to make the gift, e.g. pc, mobile or tablet.
Donor Address: Line 1
 donor_address_line1 string

The address line 1 used by the donor for the gift.
Donor Address: Line 2
 donor_address_line2 string

The address line 2 used by the donor for the gift.
Donor Address: Location
 donor_city_place v1.GivingApi.LocationRead

The city used by the donor for the gift.
Donor Email
 donor_email email

Email ID used by the donor for the gift.
Donor Name
 donor_name string

Full name of the donor.
Donor Phone Number
 donor_phone_number string

Phone Number used by the donor for the gift.
Donor Address: Zip Code
 donor_zip_code string

The zip code of the address used by the donor for the gift.
Is hidden from Leaderboard?
 exclude_from_leaderboard boolean

Is hidden from Leaderboard?
External Database ID
 external_database_id string

A system assigned unique ID for the gift by the external database.
Tribute Message
 honor_message string

A message for a gift tribute.
Tribute Prefix
 honor_prefix string

A prefix for a gift tribute. Available options are in_honor_of, in_memory_of, in_support_of
ID
 id integer

System generated ID to uniquely identify a gift.
Influencer
 influencer v1.GivingApi.InfluencerRead

The public share link and private dashboard link
Is Anonymous?
 is_anonymous boolean

Indicates the wish of donor be be anonymous to other donors for this gift.
Has donor covered the payment gateway charges?
 is_donor_covered_charges boolean

Indicates if the donor has opted to cover the payment gateway charges when making the this gift?
Is Email Added to a Record on Almabase?
 is_email_added_to_profile boolean

Indicates if the email provided by donor is added on Almabase record (irrespective of is_email_new status)
Is New Email?
 is_email_new boolean

Indicates if the email provided by donor already exists on Almabase records.
Is Mapping to a Record on Almabase Ignored?
 is_profile_mapping_ignored boolean

Indicates if the record mapping should be ignored.
Mode of Payment
 mode string

Mode of Payment, either online or offline.
Note
 note string

The note text.
Other Fund Name
 other_fund_name string

When the donor selects a fund that's marked as is_other_fund, they add a custom fund name to attribute the gift.
Giving Page
 page v1.GivingApi.GivingPageAssociatedWithGift

The giving page associated with the gift.
Fields
 post_payment_form_entry.fields array of v1.GivingApi.FormFieldRead
Response ID
 post_payment_form_entry.id integer

System generated ID to uniquely identify a form submission.
Fields
 pre_payment_form_entry.fields array of v1.GivingApi.FormFieldRead
Response ID
 pre_payment_form_entry.id integer

System generated ID to uniquely identify a form submission.
Mapped Record
 profile v1.GivingApi.RecordRead

Mapped Record on Almabase
Referrer Link
 referrer_link string

The website link to identify the source of how the donor visit. e.g. Donor visited the Giving campaign from Facebook, Google, etc.
Refund Amount
 refund_amount string

The amount refunded to the donor. If the whole amount is refunded, the status of the gift would be refunded instead of completed.
Splits
 splits array of v1.GivingApi.GiftSplitRead

The splits associated with the gift.
Status
 status string

Status of the gift.
Online Transaction
 transaction v1.GivingApi.TransactionRead

The online payment transaction associated with the gift.
UTM Campaign
 utm_campaign string

Used for keyword analysis. utm_campaign identify a specific product promotion or strategic campaign. e.g. annual_fund_2020
UTM Medium
 utm_medium string

utm_medium identify a medium such as email or cost-per- click. e.g. cpc
UTM Source
 utm_source string

utm_source identify a search engine, newsletter name, or other source. e.g. Google

v1.GivingApi.GiftSplitRead

Gift Split

Name Path Type Description
Amount
 amount string

The amount of the gift split.
Fund
 fund v1.GivingApi.FundRead

The fund associated with the gift split.
ID
 id integer

System generated ID to uniquely identify a gift split.

v1.GivingApi.GivingPageAssociatedWithGift

The giving page associated with the gift.

Name Path Type Description
ID
 id integer

System generated ID to uniquely identify a giving page.
Name
 name string

Name of the associated Giving Page.

v1.GivingApi.GivingPageRead

Giving Page

Name Path Type Description
ID
 id integer

System generated ID to uniquely identify a giving page.
Name
 name string

Name of the giving page

v1.GivingApi.InfluencerRead

The public share link and private dashboard link

Name Path Type Description
Private Influencer Dashboard Link
 dashboard_url uri

The private dashboard of the donor to monitor the number of page visits and gifts influenced by them
Public Share Link
 page_share_url uri

The public link of giving page/campaign of donor to track the influence on visits to Giving Page and the gifts.

v1.GivingApi.PaymentAccountRead

The payment account associated with the transaction, e.g. BBMS, Stripe, Paypal, etc.

Name Path Type Description
ID
 id integer

System generated ID to uniquely identify a payment account.
Name
 name string

The name of the payment account.
Gateway
 type string

The name of the payment gateway.

v1.GivingApi.RecordRead

Mapped Record on Almabase

Name Path Type Description
External Database ID
 external_database_id string

A system assigned unique ID for the record by the external database. e.g. System Record ID for Raiser Edge NXT, Contact Id for Salesforce
First Name
 first_name string

First name of the mapped record
Full Name
 formatted_name string

Full name of the mapped record
ID
 id integer

System generated ID to uniquely identify a record.
Is Donor Registered on Almabase?
 is_registered boolean

Indicate if the mapped record or donor registered on Almabase
Last Name
 last_name string

Last name of the mapped record
Picture URL
 present_picture uri

The url of the record picture
Link
 profile_url uri

The record link on Almabase

v1.GivingApi.TransactionRead

The online payment transaction associated with the gift.

Name Path Type Description
Payment Account
 account v1.GivingApi.PaymentAccountRead

The payment account associated with the transaction, e.g. BBMS, Stripe, Paypal, etc.
Created at
 created_at date-time

The time of creating of this transaction.
Failure Reason
 failure_reason string

The transaction failure reason returned by the payment gateway.
ID
 id uuid

System generated ID to uniquely identify a transaction.
Status
 status integer

Status of the transaction. - 1 (Unprocessed) - 2 (Succeeded) - 3 (Failed) - 4 (Pending) - 5 (Error) NOTE: These status are associated with the status of transaction by the Payment Gateway
Payment Gateway Reference ID
 transaction_id string

The unique ID generated by the payment gateway to identify the transaction. e.g. Blackbaud Merchant Services (BBMS) transaction ID, or Stripe Charge ID, Paypal transaction ID

v1.AlmasightsApi.RecordAddOrEdit

Record on Almabase.

Name Path Type Description
ID
 id integer

System generated ID to uniquely identify a record.

v1.AlmasightsApi.TouchpointCustomObjectAdd

Touchpoint body to create a new touchpoint

Name Path Type Description
Email
 email email

Email ID used for the activity.
Record
 mapped_profile v1.AlmasightsApi.RecordAddOrEdit

Record on Almabase.
Recorded At
 recorded_at date-time

The timestamp of the activity.
Type
 touchpoint_type.id integer

v1.RecordApi.LocationRead

Location of the Address

Name Path Type Description
City
 city string

City name of the location
Country
 country string

Country name of the location
Latitude
 latitude double

The latitude of the location
Longitude
 longitude double

The longitude of the location
State
 state string

State name of the location

v1.RecordApi.AddressRead

Address

Name Path Type Description
Line1
 line1 string

Line 1 of the address
Line2
 line2 string

Line 2 of the address
schema
 location.schema v1.RecordApi.LocationRead

Location of the Address
Zipcode
 zipcode string

Zipcode of the address

v1.RecordApi.EmailWebhookRecordRead

Record

Name Path Type Description
External Database ID
 external_database_id string

A system assigned unique ID for the record by the external database. e.g. System Record ID for Raiser Edge NXT, Contact Id for Salesforce
First Name
 first_name string

First name of the mapped record
ID
 id integer

System generated ID to uniquely identify a record.
Is record Registered on Almabase?
 is_registered boolean

Indicate if the mapped record registered on Almabase
Last Name
 last_name string

Last name of the mapped record

v1.RecordApi.EmailWebhookResponse

Name Path Type Description
Email Address
 data.address email

Email address.
ID
 data.id integer

System generated ID to uniquely identify an email.
Is Primary
 data.is_primary boolean

Indicates whether the email is primary or not.
schema
 data.profile.schema v1.RecordApi.EmailWebhookRecordRead

Record
Email Type
 data.type string

Type of the email address (primary, personal, work, etc).
Event Triggered At
 time string

The event time.
Event Type
 type string

The event type.

v1.RecordApi.RecordWebhookResponse

Name Path Type Description
Affiliations
 data.affiliations array of string
Class Year
 data.class_year string

Class year of the record
Email Address
 data.email email

Email address.
External Database ID
 data.external_database_id string

A system assigned unique ID for the record by the external database. e.g. System Record ID for Raiser Edge NXT, Contact Id for Salesforce
First Name
 data.first_name string

First name of the mapped record
schema
 data.home_address.schema v1.RecordApi.AddressRead

Address
ID
 data.id integer

System generated ID to uniquely identify a record.
Last Name
 data.last_name string

Last name of the mapped record
Membership Expiry Date
 data.membership_expiry_date date-time

Expiry date of the membership of the record
Membership Type Name
 data.membership_type_name string

Name of the membership type of the record
Mobile Number
 data.mobile_number string

Mobile number of the record
schema
 data.office_address.schema v1.RecordApi.AddressRead

Address
Office Phone Number
 data.office_phone_number string

Office phone number of the record
Residence Phone Number
 data.residence_phone_number string

Residence phone number of the record
Event Triggered At
 time string

The event time.
Event Type
 type string

The event type.

v1.RecordApi.EmailAddressRead

Email Address

Name Path Type Description
Address
 address email

The email address
ID
 id integer

System generated ID to uniquely identify a email address of a record.
Is Engaged?
 is_engaged boolean

Indicates if a bulk email is clicked or open, or the user reply to a one to one email
Use for Login?
 is_login_email boolean

Indicates if the user are allowed to login to the Platform using this email address.
Is Primary?
 is_primary boolean

A primary email is used to send the automated emails triggered by the System. It is also used to send the bulk email to the record. It's mandatory that only one email is set as primary.
Is Verified by User?
 is_verified boolean

Indicate if the user has verified that they own the email.
source
 source string

The source indicate how the email is added to the database.
status
 status string
Type
 type string

The type of the email

v1.RecordApi.RecordRead

record

Name Path Type Description
Email Addresses
 email_addresses array of v1.RecordApi.EmailAddressRead

List of email addresses of a profile
External Database ID
 external_database_id string

A system assigned unique ID for the record by the external database. e.g. System Record ID for Raiser Edge NXT, Contact Id for Salesforce
First Name
 first_name string

First name of the record.
Full Name
 formatted_name string

Full name of the record.
ID
 id integer

System generated ID to uniquely identify a record.
Is Registered on Almabase?
 is_registered boolean

Indicate if the record or donor registered on Almabase
Last Name
 last_name string

Last name of the record.
Picture URL
 present_picture uri

The url of the record picture
Link
 record_url uri

The record link on Almabase

v1.EventApi.ContactPersonRead

Contact person of an event

Name Path Type Description
Email
 email email

Email of the contact person
ID
 id integer

System generated ID to uniquely identify a contact person.
Name
 name string

Name of the contact person
Phone Number
 phone_number string

Phone number of the contact person

v1.EventApi.EventRead

Event

Name Path Type Description
Description
 description string

Description of the event
End Time
 end_datetime string

End time of the event
External Database ID
 external_database_id string

A system assigned unique ID for the record by the external database. e.g. System Record ID for Raiser Edge NXT, Contact Id for Salesforce
External Registration Url
 external_registration_url string

The registration url of the event on an external website
ID
 id integer

System generated ID to uniquely identify an event.
Name
 name string

Name of the event
Start Time
 start_datetime string

Start time of the event
Timezone
 timezone string

Timezone of the event