通过

Almabase （预览版）

Almabase 是世界上最受欢迎的校友管理软件，旨在建立以校友为中心的计划，以增加参与度、捐赠者参与度和主办参与在线社区。

此连接器在以下产品和区域中可用：

服务 Class 区域
Copilot Studio 高级 除以下各项外的所有 Power Automate 区域 ：
     - 美国政府 （GCC）
     - 美国政府 （GCC High）
     - 由世纪互联运营的中国云
     - 美国国防部（DoD）
逻辑应用程序 标准 除以下各项外的所有 逻辑应用区域 ：
     - Azure 政府区域
     - Azure 中国区域
     - 美国国防部（DoD）
Power Apps 高级 除以下各项外的所有 Power Apps 区域 ：
     - 美国政府 （GCC）
     - 美国政府 （GCC High）
     - 由世纪互联运营的中国云
     - 美国国防部（DoD）
Power Automate 高级 除以下各项外的所有 Power Automate 区域 ：
     - 美国政府 （GCC）
     - 美国政府 （GCC High）
     - 由世纪互联运营的中国云
     - 美国国防部（DoD）
联系人​​
Name Almabase 支持
URL https://docs.almabase.com
Email help@almabase.com
连接器元数据
发布者 Almabase， Inc.
Website https://almabase.com
隐私策略 https://www.almabase.com/ecloud-privacy-policy
类别 销售和 CRM;生产力

Almabase 为教育机构提供软件工具和策略，以构建以校友为中心的计划，使未接触的校友成为终身支持者。

此连接器基于 Almabase API 和 Webhook 构建，提供作来帮助管理 Almabase 中找到的实体，包括：

  • 记录 （选民）
  • 礼物
  • 事件
  • Engagement Touchpoints
  • 表单
  • 资金
  • 提供页面
  • 对等筹款活动
  • 等等...

先决条件

若要使用此连接器，

  • 必须具有有效的 Almabase 订阅。
  • 必须具有站点管理员角色。

如何获取凭据

  • 登录到 Almabase 提供的管理门户。
  • 导航到 API's & Tokens 下 Settings。
  • 单击 Add Auth Token并填写 description，并设置令牌 expiry date & time。
  • 记下 Workflow Access Token （单击令牌以在剪贴板上复制）。
  • 在 Workflow Access Token Power Automate 上创建新连接时使用。

连接器入门

常见用例

  • 制作礼品时，发送个性化消息和礼品收据。
  • 在 Slack、Gmail 或任何其他社交媒体上记录参与活动时，使用 Create Custom Touchpoint 作将参与活动添加到 Almabase 上的 Engagement Studio。
  • 当在礼品或活动注册或表单提交中找到新的电子邮件地址（丢失的校友），请将该电子邮件地址添加到 Almabase 上的记录或 Raiser 边缘的构成者或 Salesforce 上的联系人。
  • 在 Almabase 和 Blackbaud Raiser 的 Edge 之间设计双向数据同步。
  • 在 Almabase 和 Salesforce 之间设计双向数据同步。

已知问题和限制

  • 仅当在 Almabase 上支付在线付款时，礼品触发才起作用。 手动添加的礼品不会触发流。

正在创建连接

连接器支持以下身份验证类型：
默认 用于创建连接的参数。 所有区域 不可共享

违约

适用：所有区域

用于创建连接的参数。

这是不可共享的连接。 如果 Power App 与另一个用户共享，系统会提示其他用户显式创建新连接。

Name 类型 Description 必选
域 URL 字符串 指定 Almabase 域 URL，例如 https://your.domain.com True
API 密钥 securestring 用户的 API 密钥 True

限制

名称 调用 续订期
每个连接的 API 调用数 100 60 秒

操作

为记录创建电子邮件地址

为记录创建新的电子邮件地址。
列出事件

返回所有事件的列表。
列出基金

返回基金列表
列出提供页面

返回给定页面的列表。
列出礼品

返回礼物列表。
列出联系人

返回事件中所有联系人的列表。
列出表单

获取表单列表。
列出记录

返回记录列表。
列出记录的电子邮件地址

返回记录的电子邮件地址列表。
创建事件

创建新事件。
创建基金

创建新的基金。
创建礼物

创建新礼物。
创建触摸点

将新的自定义触摸点发送到 Almabase。
创建记录

创建新记录。
删除记录的电子邮件地址

删除记录的电子邮件地址。
提交表单

为表单创建新表单提交
更新事件

更新事件。
更新基金

更新基金。
更新礼品

更新礼品
更新联系人

更新事件的联系人。
更新记录

更新记录。
更新记录的电子邮件地址

更新记录的电子邮件地址的字段
添加联系人

将联系人添加到事件。
获取事件

返回有关事件的信息。
获取基金

返回有关基金的信息。
获取礼物

返回有关礼品的信息。
获取给定页面

返回有关给定页面的信息。
获取表单的提交

返回有关表单提交的信息。
获取记录

返回有关记录的信息。
获取记录的电子邮件地址

返回有关记录的电子邮件地址的信息。

为记录创建电子邮件地址

操作 ID:
CreateRecordEmailAddress

为记录创建新的电子邮件地址。

参数

名称 密钥 必需 类型 说明
记录 ID
 record_id True integer

系统生成的 ID 用于唯一标识记录。
地址
 address email

电子邮件地址
用于登录？
 is_login_email boolean

指示是否允许用户使用此电子邮件地址登录到平台。
主数据库是吗？
 is_primary boolean

主电子邮件用于发送系统触发的自动电子邮件。 它还用于将批量电子邮件发送到配置文件。 必须仅将一封电子邮件设置为主要电子邮件。
来源
 source string

源指示如何将电子邮件添加到数据库。
状态
 status string

电子邮件地址的状态
类型
 type string

电子邮件的类型

返回

电子邮件地址

Body
v1.RecordApi.EmailAddressRead

列出事件

操作 ID:
ListEvents

返回所有事件的列表。

参数

名称 密钥 必需 类型 说明
按外部数据库 ID 搜索
 external_database_id string

按外部数据库 ID 搜索事件。
Fields
 fields array

响应中字段的逗号分隔列表。

返回

response
array of v1.EventApi.EventRead

列出基金

操作 ID:
ListFunds

返回基金列表

参数

名称 密钥 必需 类型 说明
Fields
 fields array

响应中字段的逗号分隔列表。

返回

response
array of v1.GivingApi.FundRead

列出提供页面

操作 ID:
ListGivingPages

返回给定页面的列表。

参数

名称 密钥 必需 类型 说明
Fields
 fields array

响应中字段的逗号分隔列表。

返回

response
array of v1.GivingApi.GivingPageRead

列出礼品

操作 ID:
ListGifts

返回礼物列表。

参数

名称 密钥 必需 类型 说明
状态
 status True string

根据状态筛选礼品。
“提供”页
 campaign integer

系统生成的 ID 用于唯一标识给定页面。
按礼品组 ID 进行筛选
 group_id uuid

系统生成的 ID 用于唯一标识礼品组或列表。
应该有空批号？
 batch_number__isnull boolean

根据礼品的批号筛选礼品。
应该有空的外部数据库 ID？
 external_database_id__isnull boolean

根据它们已有外部数据库 ID 筛选礼品。 注意：具有外部数据库 ID 的礼品已推送到外部数据库。
按外部数据库 ID 进行筛选
 external_database_id string

根据外部数据库 ID 筛选礼品。
按捐赠者电子邮件进行筛选
 donor_email string

根据捐赠者电子邮件地址筛选礼品
搜索依据
 search string

按姓名或电子邮件地址搜索礼品。
Fields
 fields array

响应中字段的逗号分隔列表。
页面大小
 page_size integer

表示要返回的记录数。 默认值是10。 最大值为 50。
页码
 page integer

表示页码（偏移量）。 用于分页。
订单依据
 ordering string

定义响应中礼品的顺序。 “-”前缀表示降序，并且缺少前缀将按升序返回结果。

返回

名称 路径 类型 说明
下一个结果 URL
 nextlink uri

下一页结果集的 URL。 用于分页。
以前的结果 URL
 previouslink uri

上一组结果的 URL。 用于分页。
总礼品
 total integer

给定筛选器的总礼物
礼物
 value array of v1.GivingApi.GiftRead

为给定筛选器返回的礼物列表。 结果分页。

列出联系人

操作 ID:
ListEventContactPersons

返回事件中所有联系人的列表。

参数

名称 密钥 必需 类型 说明
事件编号
 id True integer

系统生成的 ID 用于唯一标识事件。

返回

response
array of v1.EventApi.ContactPersonRead

列出表单

操作 ID:
ListForms

获取表单列表。

参数

名称 密钥 必需 类型 说明
Fields
 fields array

响应中字段的逗号分隔列表。

返回

response
array of v1.FormApi.FormRead

列出记录

操作 ID:
ListRecords

返回记录列表。

参数

名称 密钥 必需 类型 说明
按名称搜索
 search string

按名称搜索记录。
按电子邮件地址搜索
 email_addresses__address string

按电子邮件地址搜索记录。
按外部数据库 ID 搜索
 external_database_id string

按外部数据库 ID 搜索记录。
Fields
 fields array

响应中字段的逗号分隔列表。
更新或更新后
 updated_at__gte date-time

日期或日期之后更新。
在或之后创建
 created_at__gte date-time

创建日期或日期之后。
页面大小
 page_size integer

表示要返回的记录数。 默认值是10。 最大值为 50。
页码
 page integer

表示页码（偏移量）。 用于分页。

返回

名称 路径 类型 说明
下一个结果 URL
 nextlink uri

下一页结果集的 URL。 用于分页。
以前的结果 URL
 previouslink uri

上一组结果的 URL。 用于分页。
记录总数
 total integer

给定筛选器的总记录数
记录
 value array of v1.RecordApi.RecordRead

为给定筛选器返回的记录的列表。

列出记录的电子邮件地址

操作 ID:
ListRecordEmailAddresses

返回记录的电子邮件地址列表。

参数

名称 密钥 必需 类型 说明
记录 ID
 record_id True integer

系统生成的 ID 用于唯一标识记录。
主数据库是吗？
 is_primary boolean

搜索主要电子邮件。
Fields
 fields array

响应中字段的逗号分隔列表。
页面大小
 page_size integer

表示要返回的记录数。 默认值是10。 最大值为 50。
页码
 page integer

表示页码（偏移量）。 用于分页。

返回

名称 路径 类型 说明
下一个结果 URL
 nextlink uri

下一页结果集的 URL。 用于分页。
以前的结果 URL
 previouslink uri

上一组结果的 URL。 用于分页。
电子邮件地址总数
 total integer

给定筛选器的电子邮件地址总数
电子邮件地址
 value array of v1.RecordApi.EmailAddressRead

为给定筛选器返回的记录的电子邮件地址列表。 结果分页。

创建事件

操作 ID:
CreateEvent

创建新事件。

参数

名称 密钥 必需 类型 说明
Description
 description string

事件说明
结束时间
 end_datetime string

事件的结束时间
外部数据库 ID
 external_database_id string

由外部数据库为记录分配的系统唯一 ID。 例如 Raiser Edge NXT 的系统记录 ID、Salesforce 的联系人 ID
外部注册 URL
 external_registration_url string

外部网站上的事件的注册 URL
Name
 name True string

事件的名称
开始时间
 start_datetime string

事件的开始时间
Timezone
 timezone string

事件的时区
Name
 display_name string

市、州、会场国家/地区

返回

事件 / 活动

Body
v1.EventApi.EventRead

创建基金

操作 ID:
CreateFund

创建新的基金。

参数

名称 密钥 必需 类型 说明
外部数据库 ID
 external_database_id string

由外部数据库为基金分配的唯一 ID 的系统。 例如 Raiser Edge NXT 的系统记录 ID、Salesforce 的对象 ID
默认基金是吗？
 is_default boolean

如果“捐赠”页面上没有定义其他任何基金，则表示将所有拆分关联到该基金。
其他基金吗？
 is_other_fund boolean

指示该基金的捐赠者已指定自定义基金名称。
基金名称
 name True string

基金名称

返回

与礼品拆分相关的基金。

基金
v1.GivingApi.FundRead

创建礼物

操作 ID:
CreateGift

创建新礼物。

参数

名称 密钥 必需 类型 说明
礼品金额
 amount True string

带有两个小数的礼品金额。
批号
 batch_number string

礼品的批号。
礼品日期
 completed_at True date-time

礼品状态标记为已完成的日期。
货币
 currency True integer

捐赠者用于礼物的货币。
捐赠者地址：第 1 行
 donor_address_line1 string

捐赠者用于礼物的地址行 1。
捐赠者地址：第 2 行
 donor_address_line2 string

捐赠者用于礼物的地址行 2。
名称：城市、州、国家/地区
 name string

捐赠者的城市。 格式：城市名称、短州名称、短国家/地区名称
捐赠者电子邮件
 donor_email True email

捐赠者用于礼物的电子邮件 ID。
捐赠者名称
 donor_name True string

捐赠者的全名。
捐赠者电话号码
 donor_phone_number string

捐赠者用于礼物的电话号码。
捐赠者地址：邮政编码
 donor_zip_code string

捐赠者用于礼物的地址的邮政编码。
是否隐藏在排行榜上？
 exclude_from_leaderboard boolean

是否隐藏在排行榜上？
外部数据库 ID
 external_database_id string

由外部数据库为礼品分配的系统唯一 ID。
致敬信息
 honor_message string

礼物致敬的信息。
致敬前缀
 honor_prefix string

礼物致敬的前缀。 可用选项包括in_honor_of、in_memory_of、in_support_of
匿名吗？
 is_anonymous boolean

表示捐赠者的愿望是匿名给其他捐赠者提供这一礼物。
付款模式
 mode True string

付款模式，无论是联机还是脱机。
注释
 note string

备注文本。
其他基金名称
 other_fund_name string

当捐赠者选择标记为is_other_fund的基金时，他们添加了一个自定义基金名称来归因于礼物。
“提供”页
 id integer

系统生成的 ID 用于唯一标识给定页面。
ID
 id integer

系统生成的 ID 用于唯一标识记录。
金额
 amount True string

礼物的拆分量。
基金
 id True integer

系统生成的 ID 用于唯一标识基金。
状态
 status True string

礼物的状态。

返回

礼物

Body
v1.GivingApi.GiftRead

创建触摸点

操作 ID:
createTouchpointCustomObject

将新的自定义触摸点发送到 Almabase。

参数

名称 密钥 必需 类型 说明
Program
 touchpoint_program True integer

按 touchpoint 程序筛选类型。
Email
 email email

用于活动的电子邮件 ID。
ID
 id integer

系统生成的 ID 用于唯一标识记录。
记录在
 recorded_at True date-time

活动的时间戳。
类型
 id True integer

返回

用于创建新的触摸点的触摸点正文

Body
v1.AlmasightsApi.TouchpointCustomObjectAdd

创建记录

操作 ID:
CreateRecord

创建新记录。

参数

名称 密钥 必需 类型 说明
第 1 行
 line1 True string

地址的第 1 行
第 2 行
 line2 string

地址的第 2 行
Name
 name string

城市、州、国家/地区
隐私
 privacy string

隐私
类型
 type True string

数字的类型
Zipcode
 zip_code string

地址的邮政编码
出生日期
 date_of_birth string

出生日期。
死者
 deceased boolean

死者。
地址
 address email

电子邮件地址
用于登录？
 is_login_email boolean

指示是否允许用户使用此电子邮件地址登录到平台。
主数据库是吗？
 is_primary boolean

主电子邮件用于发送系统触发的自动电子邮件。 它还用于将批量电子邮件发送到配置文件。 必须仅将一封电子邮件设置为主要电子邮件。
来源
 source string

源指示如何将电子邮件添加到数据库。
状态
 status string

电子邮件地址的状态
类型
 type string

电子邮件的类型
外部数据库 ID
 external_database_id string

由外部数据库为记录分配的系统唯一 ID。 例如 Raiser Edge NXT 的系统记录 ID、Salesforce 的联系人 ID
外部数据库查找 ID
 external_database_lookup_id string

外部数据库中记录的自定义用户定义查找 ID。 例如构成 ID
名字
 first_name True string

记录的名字。
姓氏
 last_name True string

记录的姓氏。
中间名
 middle_name string

记录的中间名称。
编号
 number True string

编号
隐私
 privacy string

隐私
类型
 type True string

数字的类型

返回

记录

Body
v1.RecordApi.RecordRead

删除记录的电子邮件地址

操作 ID:
DeleteRecordEmailAddress

删除记录的电子邮件地址。

参数

名称 密钥 必需 类型 说明
记录 ID
 record_id True integer

系统生成的 ID 用于唯一标识记录。
ID
 email_id True integer

系统生成的 ID，用于唯一标识记录的电子邮件地址。

提交表单

操作 ID:
CreateFormEntry

为表单创建新表单提交

参数

名称 密钥 必需 类型 说明
表格
 form_id True integer

系统生成的 ID 用于唯一标识表单。
身体
 body dynamic

创建新表单提交

返回

名称 路径 类型 说明
响应 ID
 id integer

系统生成的 ID 用于唯一标识表单提交。

更新事件

操作 ID:
UpdateEvent

更新事件。

参数

名称 密钥 必需 类型 说明
事件编号
 id True integer

系统生成的 ID 用于唯一标识事件。
Description
 description string

事件说明
结束时间
 end_datetime string

事件的结束时间
外部数据库 ID
 external_database_id string

由外部数据库为记录分配的系统唯一 ID。 例如 Raiser Edge NXT 的系统记录 ID、Salesforce 的联系人 ID
外部注册 URL
 external_registration_url string

外部网站上的事件的注册 URL
Name
 name string

事件的名称
开始时间
 start_datetime string

事件的开始时间
Timezone
 timezone string

事件的时区
Name
 display_name string

市、州、会场国家/地区

返回

事件 / 活动

Body
v1.EventApi.EventRead

更新基金

操作 ID:
UpdateFund

更新基金。

参数

名称 密钥 必需 类型 说明
基金 ID
 id True integer

系统生成的 ID 用于唯一标识基金。
外部数据库 ID
 external_database_id string

由外部数据库为基金分配的唯一 ID 的系统。 例如 Raiser Edge NXT 的系统记录 ID、Salesforce 的对象 ID
默认基金是吗？
 is_default boolean

如果“捐赠”页面上没有定义其他任何基金，则表示将所有拆分关联到该基金。
其他基金吗？
 is_other_fund boolean

指示该基金的捐赠者已指定自定义基金名称。
基金名称
 name True string

基金名称

返回

与礼品拆分相关的基金。

基金
v1.GivingApi.FundRead

更新礼品

操作 ID:
UpdateGift

更新礼品

参数

名称 密钥 必需 类型 说明
礼品 ID
 id True integer

系统生成的 ID 用于唯一标识礼品。
批号
 batch_number string

礼品的批号。
捐赠者地址：第 1 行
 donor_address_line1 string

捐赠者用于礼物的地址行 1。
捐赠者地址：第 2 行
 donor_address_line2 string

捐赠者用于礼物的地址行 2。
名称：城市、州、国家/地区
 name string

捐赠者的城市。 格式：城市名称、短州名称、短国家/地区名称
捐赠者名称
 donor_name string

捐赠者的全名。
捐赠者电话号码
 donor_phone_number string

捐赠者用于礼物的电话号码。
捐赠者地址：邮政编码
 donor_zip_code string

捐赠者用于礼物的地址的邮政编码。
是否隐藏在排行榜上？
 exclude_from_leaderboard boolean

是否隐藏在排行榜上？
外部数据库 ID
 external_database_id string

由外部数据库为礼品分配的系统唯一 ID。
致敬信息
 honor_message string

礼物致敬的信息。
致敬前缀
 honor_prefix string

礼物致敬的前缀。 可用选项包括in_honor_of、in_memory_of、in_support_of
匿名吗？
 is_anonymous boolean

表示捐赠者的愿望是匿名给其他捐赠者提供这一礼物。
注释
 note string

备注文本。
其他基金名称
 other_fund_name string

当捐赠者选择标记为is_other_fund的基金时，他们添加了一个自定义基金名称来归因于礼物。
“提供”页
 id integer

系统生成的 ID 用于唯一标识给定页面。
ID
 id integer

系统生成的 ID 用于唯一标识记录。
金额
 amount True string

礼物的拆分量。
基金
 id True integer

系统生成的 ID 用于唯一标识基金。

返回

礼物

Body
v1.GivingApi.GiftRead

更新联系人

操作 ID:
UpdateEventContactPerson

更新事件的联系人。

参数

名称 密钥 必需 类型 说明
事件编号
 id True integer

系统生成的 ID 用于唯一标识事件。
事件联系人 ID
 person_id True integer

系统生成的 ID，用于唯一标识事件中的联系人。
Email
 email email

联系人的电子邮件
Name
 name string

联系人姓名
电话号码
 phone_number string

联系人的电话号码

返回

事件的联系人

Body
v1.EventApi.ContactPersonRead

更新记录

操作 ID:
UpdateRecord

更新记录。

参数

名称 密钥 必需 类型 说明
记录 ID
 id True integer

系统生成的 ID 用于唯一标识记录。
外部数据库 ID
 external_database_id string

由外部数据库为记录分配的系统唯一 ID。 例如 Raiser Edge NXT 的系统记录 ID、Salesforce 的联系人 ID
外部数据库查找 ID
 external_database_lookup_id string

外部数据库中记录的自定义用户定义查找 ID。 例如构成 ID
名字
 first_name string

记录的名字。
姓氏
 last_name string

记录的姓氏。

返回

记录

Body
v1.RecordApi.RecordRead

更新记录的电子邮件地址

操作 ID:
UpdateRecordEmailAddress

更新记录的电子邮件地址的字段

参数

名称 密钥 必需 类型 说明
记录 ID
 record_id True integer

系统生成的 ID 用于唯一标识记录。
电子邮件地址 ID
 email_id True integer

系统生成的 ID，用于唯一标识记录的电子邮件地址。
用于登录？
 is_login_email boolean

指示是否允许用户使用此电子邮件地址登录到平台。
主数据库是吗？
 is_primary boolean

主电子邮件用于发送系统触发的自动电子邮件。 它还用于将批量电子邮件发送到配置文件。 必须仅将一封电子邮件设置为主要电子邮件。
状态
 status string

电子邮件地址的状态
类型
 type string

电子邮件的类型

返回

电子邮件地址

Body
v1.RecordApi.EmailAddressRead

添加联系人

操作 ID:
AddEventContactPerson

将联系人添加到事件。

参数

名称 密钥 必需 类型 说明
事件编号
 id True integer

系统生成的 ID 用于唯一标识事件。
Email
 email email

联系人的电子邮件
Name
 name string

联系人姓名
电话号码
 phone_number string

联系人的电话号码

返回

事件的联系人

Body
v1.EventApi.ContactPersonRead

获取事件

操作 ID:
GetEvent

返回有关事件的信息。

参数

名称 密钥 必需 类型 说明
事件编号
 id True integer

系统生成的 ID 用于唯一标识事件。
Fields
 fields array

响应中字段的逗号分隔列表。

返回

事件 / 活动

Body
v1.EventApi.EventRead

获取基金

操作 ID:
GetFund

返回有关基金的信息。

参数

名称 密钥 必需 类型 说明
基金 ID
 id True integer

系统生成的 ID 用于唯一标识基金。
Fields
 fields array

响应中字段的逗号分隔列表。

返回

与礼品拆分相关的基金。

基金
v1.GivingApi.FundRead

获取礼物

操作 ID:
GetGift

返回有关礼品的信息。

参数

名称 密钥 必需 类型 说明
礼品 ID
 id True integer

系统生成的 ID 用于唯一标识礼品。
Fields
 fields array

响应中字段的逗号分隔列表。

返回

礼物

Body
v1.GivingApi.GiftRead

获取给定页面

操作 ID:
GetGivingPage

返回有关给定页面的信息。

参数

名称 密钥 必需 类型 说明
提供页面 ID
 id True integer

系统生成的 ID 用于唯一标识给定页面。
Fields
 fields array

响应中字段的逗号分隔列表。

返回

“提供”页

Body
v1.GivingApi.GivingPageRead

获取表单的提交

操作 ID:
GetFormEntry

返回有关表单提交的信息。

参数

名称 密钥 必需 类型 说明
表格
 form_id True integer

系统生成的 ID 用于唯一标识表单。
响应 ID
 entry_id True string

系统生成的 ID 用于唯一标识表单提交。

返回

此操作输出是动态内容。

获取记录

操作 ID:
GetRecord

返回有关记录的信息。

参数

名称 密钥 必需 类型 说明
记录 ID
 id True integer

系统生成的 ID 用于唯一标识记录。
Fields
 fields array

响应中字段的逗号分隔列表。

返回

记录

Body
v1.RecordApi.RecordRead

获取记录的电子邮件地址

操作 ID:
GetRecordEmailAddress

返回有关记录的电子邮件地址的信息。

参数

名称 密钥 必需 类型 说明
记录 ID
 record_id True integer

系统生成的 ID 用于唯一标识记录。
ID
 email_id True integer

系统生成的 ID，用于唯一标识记录的电子邮件地址。

返回

电子邮件地址

Body
v1.RecordApi.EmailAddressRead

触发器

创建电子邮件时，在记录上更新或删除

在记录上创建新电子邮件或从记录中删除现有电子邮件时触发。
在 Almabase 上创建或更新记录时

在 Almabase 上创建新记录或更新现有记录时触发。
提交表单或更新现有表单提交时

提交表单或更新现有表单提交时触发。
新礼品成功或在线礼品付款失败时

当捐赠者成功在捐赠页面上记录新礼物或向礼物付款失败时触发。

创建电子邮件时，在记录上更新或删除

操作 ID:
EmailChangedWebhook

在记录上创建新电子邮件或从记录中删除现有电子邮件时触发。

参数

名称 密钥 必需 类型 说明
When
 events True string

要触发流的事件列表。

返回

Body
v1.RecordApi.EmailWebhookResponse

在 Almabase 上创建或更新记录时

操作 ID:
RecordChangedWebhook

在 Almabase 上创建新记录或更新现有记录时触发。

参数

名称 密钥 必需 类型 说明
When
 events True string

要触发流的事件列表。

返回

Body
v1.RecordApi.RecordWebhookResponse

提交表单或更新现有表单提交时

操作 ID:
FormEntryCreateOrUpdateWebhook

提交表单或更新现有表单提交时触发。

参数

名称 密钥 必需 类型 说明
When
 events True string

要触发流的事件列表。
表格
 object_id True integer

系统生成的 ID 用于唯一标识表单。

返回

此操作输出是动态内容。

新礼品成功或在线礼品付款失败时

操作 ID:
GiftSucceededOrFailedWebhook

当捐赠者成功在捐赠页面上记录新礼物或向礼物付款失败时触发。

参数

名称 密钥 必需 类型 说明
When
 events True string

要触发流的事件列表。
“提供”页
 object_id integer

系统生成的 ID 用于唯一标识给定页面。

返回

Body
v1.GivingApi.GiftWebhookResponse

定义

v1.FormApi.FormRead

表格

名称 路径 类型 说明
ID
 id integer

系统生成的 ID 用于唯一标识表单。
表单名称
 title string

窗体的名称

v1.GivingApi.GiftWebhookRecordRead

记录

名称 路径 类型 说明
外部数据库 ID
 external_database_id string

由外部数据库为记录分配的系统唯一 ID。 例如 Raiser Edge NXT 的系统记录 ID、Salesforce 的联系人 ID
名字
 first_name string

映射记录的名字
ID
 id integer

系统生成的 ID 用于唯一标识记录。
捐赠者是否在 Almabase 上注册？
 is_registered boolean

指示在 Almabase 上注册的映射记录或捐赠者
姓氏
 last_name string

映射记录的姓氏

v1.GivingApi.GiftWebhookResponse

名称 路径 类型 说明
金额
 data.amount string

带有两个小数的礼品金额。
日期
 data.completed_at date-time

礼品状态标记为已完成的日期。
捐赠者电子邮件
 data.email email

捐赠者用于礼物的电子邮件 ID。
外部数据库 ID
 data.external_database_id string

由外部数据库为礼品分配的系统唯一 ID。
ID
 data.id integer

系统生成的 ID 用于唯一标识礼品。
新电子邮件吗？
 data.is_email_new boolean

指示捐赠者提供的电子邮件是否已存在于 Almabase 记录上。
架构
 data.mapped_profile.schema v1.GivingApi.GiftWebhookRecordRead

记录
模式
 data.mode string

礼物的模式。
捐赠者名称
 data.name string

捐赠者的全名。
ID
 data.page.id integer

系统生成的 ID 用于唯一标识给定页面。
提供页面名称
 data.page.name string

关联的授予页面的名称
状态
 data.status string

礼物的状态。
在以下位置触发的事件
 time string

事件时间。
事件类型
 type string

事件类型。

v1.GivingApi.LocationRead

捐赠者用于礼物的城市。

名称 路径 类型 说明
City
 city string

捐赠者城市
城市短名称
 city_short_name string

City 的简短表示形式，例如 SF
Latitude
 coordinates.latitude string

位置的纬度
Longitude
 coordinates.longitude string

位置的经度
国家
 country string

捐赠国
国家/地区短名称
 country_short_name string

国家/地区（例如美国）的简短表示形式
Google Place Id
 gpid string

从 Google 获取的位置 ID
城市、州、国家/地区
 name string

捐赠者的城市。 格式：城市名称、短州名称、短国家/地区名称
State
 state string

捐赠者的状态
状态短名称
 state_short_name string

状态的简短表示形式，例如 CA

v1.GivingApi.FormFieldRead

窗体域

名称 路径 类型 说明
价值
 display_value string

响应者输入的格式值。 例如文件上传的名称。
问题/表单字段名称
 label string

表单上的问题/窗体字段名称

v1.GivingApi.FundRead

与礼品拆分相关的基金。

名称 路径 类型 说明
外部数据库 ID
 external_database_id string

由外部数据库为基金分配的唯一 ID 的系统。 例如 Raiser Edge NXT 的系统记录 ID、Salesforce 的对象 ID
ID
 id integer

系统生成的 ID 用于唯一标识基金。
默认基金是吗？
 is_default boolean

如果“捐赠”页面上没有定义其他任何基金，则表示将所有拆分关联到该基金。
其他基金吗？
 is_other_fund boolean

指示该基金的捐赠者已指定自定义基金名称。
Name
 name string

基金名称

v1.GivingApi.GiftRead

礼物

名称 路径 类型 说明
礼品金额
 amount string

带有两个小数的礼品金额。
批号
 batch_number string

礼品的批号。
礼品日期
 completed_at date-time

礼品状态标记为已完成的日期。
货币
 currency integer

捐赠者用于礼物的货币。
Device
 device string

识别用于制作礼品的设备，例如电脑、移动或平板电脑。
捐赠者地址：第 1 行
 donor_address_line1 string

捐赠者用于礼物的地址行 1。
捐赠者地址：第 2 行
 donor_address_line2 string

捐赠者用于礼物的地址行 2。
捐赠者地址：位置
 donor_city_place v1.GivingApi.LocationRead

捐赠者用于礼物的城市。
捐赠者电子邮件
 donor_email email

捐赠者用于礼物的电子邮件 ID。
捐赠者名称
 donor_name string

捐赠者的全名。
捐赠者电话号码
 donor_phone_number string

捐赠者用于礼物的电话号码。
捐赠者地址：邮政编码
 donor_zip_code string

捐赠者用于礼物的地址的邮政编码。
是否隐藏在排行榜上？
 exclude_from_leaderboard boolean

是否隐藏在排行榜上？
外部数据库 ID
 external_database_id string

由外部数据库为礼品分配的系统唯一 ID。
致敬信息
 honor_message string

礼物致敬的信息。
致敬前缀
 honor_prefix string

礼物致敬的前缀。 可用选项包括in_honor_of、in_memory_of、in_support_of
ID
 id integer

系统生成的 ID 用于唯一标识礼品。
影响因素
 influencer v1.GivingApi.InfluencerRead

公共共享链接和专用仪表板链接
匿名吗？
 is_anonymous boolean

表示捐赠者的愿望是匿名给其他捐赠者提供这一礼物。
捐赠者是否有支付网关费用？
 is_donor_covered_charges boolean

指示捐赠者是否选择支付支付网关费用，当发出此礼物？
电子邮件是否添加到 Almabase 上的记录？
 is_email_added_to_profile boolean

指示捐赠者提供的电子邮件是否在 Almabase 记录上添加（无论is_email_new状态如何）
新电子邮件吗？
 is_email_new boolean

指示捐赠者提供的电子邮件是否已存在于 Almabase 记录上。
是否忽略了映射到 Almabase 上的记录？
 is_profile_mapping_ignored boolean

指示是否应忽略记录映射。
付款模式
 mode string

付款模式，无论是联机还是脱机。
注释
 note string

备注文本。
其他基金名称
 other_fund_name string

当捐赠者选择标记为is_other_fund的基金时，他们添加了一个自定义基金名称来归因于礼物。
“提供”页
 page v1.GivingApi.GivingPageAssociatedWithGift

与礼物关联的送礼页面。
Fields
 post_payment_form_entry.fields array of v1.GivingApi.FormFieldRead
响应 ID
 post_payment_form_entry.id integer

系统生成的 ID 用于唯一标识表单提交。
Fields
 pre_payment_form_entry.fields array of v1.GivingApi.FormFieldRead
响应 ID
 pre_payment_form_entry.id integer

系统生成的 ID 用于唯一标识表单提交。
映射记录
 profile v1.GivingApi.RecordRead

Almabase 上的映射记录
引用者链接
 referrer_link string

网站链接，用于确定捐赠者如何访问的来源。 例如捐赠者从Facebook、谷歌等访问了捐赠活动。
退款金额
 refund_amount string

退还给捐赠者的金额。 如果退款了整个金额，则礼品的状态将得到退款，而不是完成。
分裂
 splits array of v1.GivingApi.GiftSplitRead

与礼物关联的拆分。
状态
 status string

礼物的状态。
联机事务
 transaction v1.GivingApi.TransactionRead

与礼品关联的在线付款交易。
UTM 市场活动
 utm_campaign string

用于关键字分析。 utm_campaign标识特定的产品促销或战略活动。 例如annual_fund_2020
UTM 中等
 utm_medium string

utm_medium标识一种媒体，例如电子邮件或每单击成本。 例如 cpc
UTM 源
 utm_source string

utm_source标识搜索引擎、新闻稿名称或其他来源。 例如 Google

v1.GivingApi.GiftSplitRead

礼品拆分

名称 路径 类型 说明
金额
 amount string

礼物的拆分量。
基金
 fund v1.GivingApi.FundRead

与礼品拆分相关的基金。
ID
 id integer

系统生成的 ID 用于唯一标识礼品拆分。

v1.GivingApi.GivingPageAssociatedWithGift

与礼物关联的送礼页面。

名称 路径 类型 说明
ID
 id integer

系统生成的 ID 用于唯一标识给定页面。
Name
 name string

关联的“授予”页的名称。

v1.GivingApi.GivingPageRead

“提供”页

名称 路径 类型 说明
ID
 id integer

系统生成的 ID 用于唯一标识给定页面。
Name
 name string

提供页面的名称

v1.GivingApi.InfluencerRead

公共共享链接和专用仪表板链接

名称 路径 类型 说明
专用影响因素仪表板链接
 dashboard_url uri

捐赠者的私人仪表板，用于监视受其影响的页面访问次数和礼物数
公共共享链接
 page_share_url uri

捐赠者页面/捐赠活动的公共链接，以跟踪对捐赠页面和礼物的访问的影响。

v1.GivingApi.PaymentAccountRead

与交易关联的支付帐户，例如 BBMS、Stripe、PayPal 等。

名称 路径 类型 说明
ID
 id integer

系统生成的 ID 用于唯一标识付款帐户。
Name
 name string

付款帐户的名称。
Gateway
 type string

支付网关的名称。

v1.GivingApi.RecordRead

Almabase 上的映射记录

名称 路径 类型 说明
外部数据库 ID
 external_database_id string

由外部数据库为记录分配的系统唯一 ID。 例如 Raiser Edge NXT 的系统记录 ID、Salesforce 的联系人 ID
名字
 first_name string

映射记录的名字
完整姓名
 formatted_name string

映射记录的全名
ID
 id integer

系统生成的 ID 用于唯一标识记录。
捐赠者是否在 Almabase 上注册？
 is_registered boolean

指示在 Almabase 上注册的映射记录或捐赠者
姓氏
 last_name string

映射记录的姓氏
图片 URL
 present_picture uri

记录图片的 URL
Link
 profile_url uri

Almabase 上的记录链接

v1.GivingApi.TransactionRead

与礼品关联的在线付款交易。

名称 路径 类型 说明
付款帐户
 account v1.GivingApi.PaymentAccountRead

与交易关联的支付帐户，例如 BBMS、Stripe、PayPal 等。
创建于
 created_at date-time

创建此事务的时间。
失败原因
 failure_reason string

付款网关返回的交易失败原因。
ID
 id uuid

系统生成的 ID 用于唯一标识事务。
状态
 status integer

事务的状态。 - 1 （未处理） - 2 （成功） - 3 （失败） - 4 （挂起） - 5 （错误） 注意：这些状态与付款网关的交易状态相关联
付款网关参考 ID
 transaction_id string

付款网关生成的唯一 ID，用于标识交易。 例如 Blackbaud 商家服务（BBMS）交易 ID 或条纹费用 ID，PayPal交易 ID

v1.AlmasightsApi.RecordAddOrEdit

在 Almabase 上记录。

名称 路径 类型 说明
ID
 id integer

系统生成的 ID 用于唯一标识记录。

v1.AlmasightsApi.TouchpointCustomObjectAdd

用于创建新的触摸点的触摸点正文

名称 路径 类型 说明
Email
 email email

用于活动的电子邮件 ID。
记录
 mapped_profile v1.AlmasightsApi.RecordAddOrEdit

在 Almabase 上记录。
记录在
 recorded_at date-time

活动的时间戳。
类型
 touchpoint_type.id integer

v1.RecordApi.LocationRead

地址的位置

名称 路径 类型 说明
City
 city string

位置的城市名称
国家
 country string

位置的国家/地区名称
Latitude
 latitude double

位置的纬度
Longitude
 longitude double

位置的经度
State
 state string

位置的状态名称

v1.RecordApi.AddressRead

地址

名称 路径 类型 说明
第 1 行
 line1 string

地址的第 1 行
第2行
 line2 string

地址的第 2 行
架构
 location.schema v1.RecordApi.LocationRead

地址的位置
Zipcode
 zipcode string

地址的邮政编码

v1.RecordApi.EmailWebhookRecordRead

记录

名称 路径 类型 说明
外部数据库 ID
 external_database_id string

由外部数据库为记录分配的系统唯一 ID。 例如 Raiser Edge NXT 的系统记录 ID、Salesforce 的联系人 ID
名字
 first_name string

映射记录的名字
ID
 id integer

系统生成的 ID 用于唯一标识记录。
记录是否在 Almabase 上注册？
 is_registered boolean

指示在 Almabase 上注册的映射记录
姓氏
 last_name string

映射记录的姓氏

v1.RecordApi.EmailWebhookResponse

名称 路径 类型 说明
电子邮件地址
 data.address email

电子邮件地址。
ID
 data.id integer

系统生成的 ID 用于唯一标识电子邮件。
是主要
 data.is_primary boolean

指示电子邮件是否为主要电子邮件。
架构
 data.profile.schema v1.RecordApi.EmailWebhookRecordRead

记录
电子邮件类型
 data.type string

电子邮件地址的类型（主要、个人、工作等）。
在以下位置触发的事件
 time string

事件时间。
事件类型
 type string

事件类型。

v1.RecordApi.RecordWebhookResponse

名称 路径 类型 说明
背景
 data.affiliations array of string
Class Year
 data.class_year string

记录的类年
电子邮件地址
 data.email email

电子邮件地址。
外部数据库 ID
 data.external_database_id string

由外部数据库为记录分配的系统唯一 ID。 例如 Raiser Edge NXT 的系统记录 ID、Salesforce 的联系人 ID
名字
 data.first_name string

映射记录的名字
架构
 data.home_address.schema v1.RecordApi.AddressRead

地址
ID
 data.id integer

系统生成的 ID 用于唯一标识记录。
姓氏
 data.last_name string

映射记录的姓氏
成员资格到期日期
 data.membership_expiry_date date-time

记录成员资格的到期日期
成员身份类型名称
 data.membership_type_name string

记录的成员身份类型的名称
移动电话号码
 data.mobile_number string

记录的移动号
架构
 data.office_address.schema v1.RecordApi.AddressRead

地址
Office 电话号码
 data.office_phone_number string

记录的 Office 电话号码
住宅电话号码
 data.residence_phone_number string

记录的居住电话号码
在以下位置触发的事件
 time string

事件时间。
事件类型
 type string

事件类型。

v1.RecordApi.EmailAddressRead

电子邮件地址

名称 路径 类型 说明
地址
 address email

电子邮件地址
ID
 id integer

系统生成的 ID，用于唯一标识记录的电子邮件地址。
是否参与？
 is_engaged boolean

指示是单击或打开批量电子邮件，还是用户回复一封电子邮件
用于登录？
 is_login_email boolean

指示是否允许用户使用此电子邮件地址登录到平台。
主数据库是吗？
 is_primary boolean

主电子邮件用于发送系统触发的自动电子邮件。 它还用于将批量电子邮件发送到记录。 必须仅将一封电子邮件设置为主要电子邮件。
是否由用户验证？
 is_verified boolean

指示用户是否已验证他们是否拥有电子邮件。
源
 source string

源指示如何将电子邮件添加到数据库。
状态
 status string
类型
 type string

电子邮件的类型

v1.RecordApi.RecordRead

记录

名称 路径 类型 说明
电子邮件地址
 email_addresses array of v1.RecordApi.EmailAddressRead

配置文件的电子邮件地址列表
外部数据库 ID
 external_database_id string

由外部数据库为记录分配的系统唯一 ID。 例如 Raiser Edge NXT 的系统记录 ID、Salesforce 的联系人 ID
名字
 first_name string

记录的名字。
完整姓名
 formatted_name string

记录的全名。
ID
 id integer

系统生成的 ID 用于唯一标识记录。
是否在 Almabase 上注册？
 is_registered boolean

指示在 Almabase 上注册的记录或捐赠者
姓氏
 last_name string

记录的姓氏。
图片 URL
 present_picture uri

记录图片的 URL
Link
 record_url uri

Almabase 上的记录链接

v1.EventApi.ContactPersonRead

事件的联系人

名称 路径 类型 说明
Email
 email email

联系人的电子邮件
ID
 id integer

系统生成的 ID 用于唯一标识联系人。
Name
 name string

联系人姓名
电话号码
 phone_number string

联系人的电话号码

v1.EventApi.EventRead

事件 / 活动

名称 路径 类型 说明
Description
 description string

事件说明
结束时间
 end_datetime string

事件的结束时间
外部数据库 ID
 external_database_id string

由外部数据库为记录分配的系统唯一 ID。 例如 Raiser Edge NXT 的系统记录 ID、Salesforce 的联系人 ID
外部注册 URL
 external_registration_url string

外部网站上的事件的注册 URL
ID
 id integer

系统生成的 ID 用于唯一标识事件。
Name
 name string

事件的名称
开始时间
 start_datetime string

事件的开始时间
Timezone
 timezone string

事件的时区