Поделиться через


Almabase (предварительная версия)

Almabase является самым любимым программным обеспечением для управления выпускниками, чтобы создать программы, ориентированные на выпускников, чтобы повысить участие, участие доноров и разместить онлайн-сообщества.

Этот соединитель доступен в следующих продуктах и регионах:

Услуга Class Регионы
Copilot Studio Премия Все регионы Power Automate , кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Логические приложения Стандарт Все регионы Logic Apps , кроме следующих:
     — Регионы Azure для государственных организаций
     — Регионы Azure Для Китая
     - Министерство обороны США (DoD)
Power Apps Премия Все регионы Power Apps , кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Power Automate Премия Все регионы Power Automate , кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Контакт
Имя Поддержка Almabase
URL https://docs.almabase.com
Адрес электронной почты help@almabase.com
Метаданные соединителя
Publisher Almabase, Inc.
Веб-сайт https://almabase.com
Политика конфиденциальности https://www.almabase.com/ecloud-privacy-policy
Категории Продажи и CRM; Продуктивность

Almabase предоставляет средства программного обеспечения и стратегии для образовательных учреждений для создания программ, ориентированных на выпускников, которые превратили незавершенных выпускников в сторонников на всю жизнь.

Этот соединитель построен на основе API Almabase и веб-перехватчиков и предоставляет операции для управления сущностями, найденными в Almabase, включая:

  • Запись (составляющие)
  • Подарки
  • Events
  • Сенсорные точки взаимодействия
  • Формы
  • Денежные средства
  • Предоставление страниц
  • Одноранговые кампании по сбору средств
  • и другие...

Предпосылки

Чтобы использовать этот соединитель,

  • У вас должна быть активная подписка Almabase.
  • У вас должна быть роль администратора сайта.

Получение учетных данных

  • Войдите на портал администрирования, предоставляемый Almabase.
  • Перейдите в API's & Tokens раздел Settings.
  • Add Auth TokenЩелкните и введите descriptionи задайте маркерexpiry date & time.
  • Запишите ( Workflow Access Token щелкните маркер, чтобы скопировать его в буфер обмена).
  • Workflow Access Token Используйте при создании нового подключения в Power Automate.

Начало работы с соединителем

Распространенные варианты использования

  • При создании подарка отправьте персонализированное сообщение и квитанцию о подарке.
  • Если действие взаимодействия записывается в Slack, Gmail или других социальных сетях, добавьте действие взаимодействия в Engagement Studio на Almabase с помощью Create Custom Touchpoint действия.
  • При обнаружении нового адреса электронной почты (потерянного выпускника) в подарке или регистрации события или отправке формы добавьте этот адрес электронной почты в запись в Almabase или компонент на Edge Raiser или контакт в Salesforce.
  • Разработка двунаправленной синхронизации данных между Almabase и Blackbaud Raiser Edge.
  • Разработка двунаправленной синхронизации данных между Almabase и Salesforce.

Известные проблемы и ограничения

  • Подарочные триггеры работают только в том случае, если онлайн-платеж производится на Almabase. Добавленные вручную подарки не активируют потоки.

Создание подключения

Соединитель поддерживает следующие типы проверки подлинности:

По умолчанию Параметры для создания подключения. Все регионы Недоступен для совместного использования

По умолчанию

Применимо: все регионы

Параметры для создания подключения.

Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.

Имя Тип Description Обязательно
URL-адрес домена струна Укажите URL-адрес домена Almabase, например. https://your.domain.com True
Ключ API securestring Ключ API пользователя True

Ограничения регулирования

Имя Вызовы Период обновления
Вызовы API для каждого подключения 100 60 секунд

Действия

Вывод списка адресов электронной почты записи

Возвращает список адресов электронной почты для записи.

Добавление контактного лица

Добавляет контактного лица в событие.

Обновить запись

Обновляет запись.

Обновление адреса электронной почты записи

Обновляет поля электронной почты записи

Обновление контактного лица

Обновляет контактного лица в событии.

Обновление подарка

Обновляет подарок

Обновление события

Обновляет событие.

Обновление фонда

Обновляет фонд.

Отправка формы

Создает новую отправку формы для формы

Перечисление средств

Возвращает список средств

Получение адреса электронной почты записи

Возвращает сведения об адресе электронной почты записи.

Получение записи

Возвращает сведения о записи.

Получение отправки формы

Возвращает сведения о отправке формы.

Получение подарка

Возвращает сведения о подарке.

Получение события

Возвращает сведения о событии.

Получение страницы предоставления

Возвращает сведения о странице предоставления.

Получение фонда

Возвращает сведения о фонде.

Создание адреса электронной почты для записи

Создает новый адрес электронной почты для записи.

Создание записи

Создает новую запись.

Создание подарка

Создает новый подарок.

Создание события

Создает новое событие.

Создание точки касания

Отправьте новую настраиваемую точку касания в Almabase.

Создание фонда

Создает новый фонд.

Список записей

Возвращает список записей.

Список контактных лиц

Возвращает список всех контактных лиц в событии.

Список подарков

Возвращает список подарков.

Список предоставления страниц

Возвращает список предоставления страниц.

Список событий

Возвращает список всех событий.

Удаление адреса электронной почты записи

Удаление адреса электронной почты записи.

Формы списка

Получение списка форм.

Вывод списка адресов электронной почты записи

Возвращает список адресов электронной почты для записи.

Параметры

Имя Ключ Обязательно Тип Описание
Код записи
record_id True integer

Созданный системой идентификатор для уникальной идентификации записи.

Является ли первичный?
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 True integer

Созданный системой идентификатор для уникальной идентификации события.

Адрес электронной почты
email email

Электронная почта контактного лица

Имя
name string

Имя контактного лица

Номер телефона
phone_number string

Номер телефона контактного лица

Возвращаемое значение

Контактное лицо события

Обновить запись

Обновляет запись.

Параметры

Имя Ключ Обязательно Тип Описание
Код записи
id True integer

Созданный системой идентификатор для уникальной идентификации записи.

Идентификатор внешней базы данных
external_database_id string

Назначенный системой уникальный идентификатор записи внешней базой данных. Например, системный идентификатор записи для raiser Edge NXT, contact id for Salesforce

Идентификатор подстановки внешней базы данных
external_database_lookup_id string

Пользовательский идентификатор подстановки для записи во внешней базе данных. Например, составной идентификатор

Имя (Первое имя)
first_name string

Имя записи.

Фамилия
last_name string

Фамилия записи.

Возвращаемое значение

запись

Обновление адреса электронной почты записи

Обновляет поля электронной почты записи

Параметры

Имя Ключ Обязательно Тип Описание
Код записи
record_id True integer

Созданный системой идентификатор для уникальной идентификации записи.

Идентификатор адреса электронной почты
email_id True integer

Созданный системой идентификатор для уникального определения адреса электронной почты записи.

Используется для входа?
is_login_email boolean

Указывает, разрешено ли пользователю войти на платформу с помощью этого адреса электронной почты.

Является ли первичный?
is_primary boolean

Основное сообщение электронной почты используется для отправки автоматических сообщений электронной почты, активированных системой. Он также используется для отправки массового сообщения электронной почты в профиль. Обязательно, чтобы только одна электронная почта была основной.

Состояние
status string

Состояние адреса электронной почты

Тип
type string

Тип сообщения электронной почты

Возвращаемое значение

Электронная почта

Обновление контактного лица

Обновляет контактного лица в событии.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор события
id True integer

Созданный системой идентификатор для уникальной идентификации события.

Идентификатор контакта события
person_id True integer

Созданный системой идентификатор для уникального идентификации контактного лица в событии.

Адрес электронной почты
email email

Электронная почта контактного лица

Имя
name string

Имя контактного лица

Номер телефона
phone_number string

Номер телефона контактного лица

Возвращаемое значение

Контактное лицо события

Обновление подарка

Обновляет подарок

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор подарка
id True integer

Созданный системой идентификатор для уникальной идентификации подарка.

Номер пакета
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

Скрыт ли он от таблицы лидеров?

Идентификатор внешней базы данных
external_database_id string

Назначенный системой уникальный идентификатор для подарка внешней базой данных.

Сообщение о дани
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 integer

Созданный системой идентификатор для уникальной идентификации записи.

Сумма
amount True string

Количество разделенного подарка.

Фонд
id True integer

Созданный системой идентификатор для уникального определения фонда.

Возвращаемое значение

Подарок

Обновление события

Обновляет событие.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор события
id True integer

Созданный системой идентификатор для уникальной идентификации события.

Description
description string

Описание события

Время окончания
end_datetime string

Время окончания события

Идентификатор внешней базы данных
external_database_id string

Назначенный системой уникальный идентификатор записи внешней базой данных. Например, системный идентификатор записи для raiser Edge NXT, contact id for Salesforce

Url-адрес внешней регистрации
external_registration_url string

URL-адрес регистрации события на внешнем веб-сайте

Имя
name string

Имя события

Время начала
start_datetime string

Время начала события

Timezone
timezone string

Часовой пояс события

Имя
display_name string

Город, штат, страна места проведения

Возвращаемое значение

Event

Обновление фонда

Обновляет фонд.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор фонда
id True integer

Созданный системой идентификатор для уникального определения фонда.

Идентификатор внешней базы данных
external_database_id string

Уникальный идентификатор, назначенный системой для фонда внешней базой данных. Например, идентификатор системной записи для raiser Edge NXT, идентификатор объекта для Salesforce

Фонд по умолчанию?
is_default boolean

Указывает, что все расколы с этим фондом не определены, если другие средства не определены на странице предоставления.

Есть ли другой фонд?
is_other_fund boolean

Указывает, что доноры этого фонда дали имя пользовательского фонда.

Имя фонда
name True string

Имя фонда

Возвращаемое значение

Фонд, связанный с разделением подарка.

Отправка формы

Создает новую отправку формы для формы

Параметры

Имя Ключ Обязательно Тип Описание
Form
form_id True integer

Созданный системой идентификатор для уникальной идентификации формы.

body
body dynamic

Создание отправки формы

Возвращаемое значение

Имя Путь Тип Описание
Идентификатор ответа
id integer

Созданный системой идентификатор для уникальной идентификации отправки формы.

Перечисление средств

Возвращает список средств

Параметры

Имя Ключ Обязательно Тип Описание
Fields
fields array

Разделенный запятыми список полей в ответе.

Возвращаемое значение

Получение адреса электронной почты записи

Возвращает сведения об адресе электронной почты записи.

Параметры

Имя Ключ Обязательно Тип Описание
Код записи
record_id True integer

Созданный системой идентификатор для уникальной идентификации записи.

Идентификатор
email_id True integer

Созданный системой идентификатор для уникального определения адреса электронной почты записи.

Возвращаемое значение

Электронная почта

Получение записи

Возвращает сведения о записи.

Параметры

Имя Ключ Обязательно Тип Описание
Код записи
id True integer

Созданный системой идентификатор для уникальной идентификации записи.

Fields
fields array

Разделенный запятыми список полей в ответе.

Возвращаемое значение

запись

Получение отправки формы

Возвращает сведения о отправке формы.

Параметры

Имя Ключ Обязательно Тип Описание
Form
form_id True integer

Созданный системой идентификатор для уникальной идентификации формы.

Идентификатор ответа
entry_id True string

Созданный системой идентификатор для уникальной идентификации отправки формы.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Получение подарка

Возвращает сведения о подарке.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор подарка
id True integer

Созданный системой идентификатор для уникальной идентификации подарка.

Fields
fields array

Разделенный запятыми список полей в ответе.

Возвращаемое значение

Подарок

Получение события

Возвращает сведения о событии.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор события
id True integer

Созданный системой идентификатор для уникальной идентификации события.

Fields
fields array

Разделенный запятыми список полей в ответе.

Возвращаемое значение

Event

Получение страницы предоставления

Возвращает сведения о странице предоставления.

Параметры

Имя Ключ Обязательно Тип Описание
Предоставление идентификатора страницы
id True integer

Созданный системой идентификатор для уникальной идентификации страницы предоставления.

Fields
fields array

Разделенный запятыми список полей в ответе.

Возвращаемое значение

Предоставление страницы

Получение фонда

Возвращает сведения о фонде.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор фонда
id True integer

Созданный системой идентификатор для уникального определения фонда.

Fields
fields array

Разделенный запятыми список полей в ответе.

Возвращаемое значение

Фонд, связанный с разделением подарка.

Создание адреса электронной почты для записи

Создает новый адрес электронной почты для записи.

Параметры

Имя Ключ Обязательно Тип Описание
Код записи
record_id True integer

Созданный системой идентификатор для уникальной идентификации записи.

Address
address email

Адрес электронной почты

Используется для входа?
is_login_email boolean

Указывает, разрешено ли пользователю войти на платформу с помощью этого адреса электронной почты.

Является ли первичный?
is_primary boolean

Основное сообщение электронной почты используется для отправки автоматических сообщений электронной почты, активированных системой. Он также используется для отправки массового сообщения электронной почты в профиль. Обязательно, чтобы только одна электронная почта была основной.

Исходный материал
source string

Источник указывает, как электронная почта добавляется в базу данных.

Состояние
status string

Состояние адреса электронной почты

Тип
type string

Тип сообщения электронной почты

Возвращаемое значение

Электронная почта

Создание записи

Создает новую запись.

Параметры

Имя Ключ Обязательно Тип Описание
Строка 1
line1 True string

Строка 1 адреса

Строка 2
line2 string

Строка 2 адреса

Имя
name string

Город, штат, страна расположения

Конфиденциальность
privacy string

конфиденциальность

Тип
type True string

Тип числа

Zipcode
zip_code string

Zipcode адреса

Дата рождения
date_of_birth string

Дата рождения.

Покойный
deceased boolean

Покойный.

Address
address email

Адрес электронной почты

Используется для входа?
is_login_email boolean

Указывает, разрешено ли пользователю войти на платформу с помощью этого адреса электронной почты.

Является ли первичный?
is_primary boolean

Основное сообщение электронной почты используется для отправки автоматических сообщений электронной почты, активированных системой. Он также используется для отправки массового сообщения электронной почты в профиль. Обязательно, чтобы только одна электронная почта была основной.

Исходный материал
source string

Источник указывает, как электронная почта добавляется в базу данных.

Состояние
status string

Состояние адреса электронной почты

Тип
type string

Тип сообщения электронной почты

Идентификатор внешней базы данных
external_database_id string

Назначенный системой уникальный идентификатор записи внешней базой данных. Например, системный идентификатор записи для raiser Edge NXT, contact id for Salesforce

Идентификатор подстановки внешней базы данных
external_database_lookup_id string

Пользовательский идентификатор подстановки для записи во внешней базе данных. Например, составной идентификатор

Имя (Первое имя)
first_name True string

Имя записи.

Фамилия
last_name True string

Фамилия записи.

Второе имя
middle_name string

Среднее имя записи.

Number
number True string

Number

Конфиденциальность
privacy string

конфиденциальность

Тип
type True string

Тип числа

Возвращаемое значение

запись

Создание подарка

Создает новый подарок.

Параметры

Имя Ключ Обязательно Тип Описание
Сумма подарка
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

Идентификатор электронной почты, используемый донором для подарка.

Имя донора
donor_name True string

Полное имя донора.

Номер телефона донора
donor_phone_number string

Номер телефона, используемый донором для подарка.

Адрес донора: почтовый индекс
donor_zip_code string

Почтовый индекс адреса, используемого донором для подарка.

Скрыт ли он от таблицы лидеров?
exclude_from_leaderboard boolean

Скрыт ли он от таблицы лидеров?

Идентификатор внешней базы данных
external_database_id string

Назначенный системой уникальный идентификатор для подарка внешней базой данных.

Сообщение о дани
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 integer

Созданный системой идентификатор для уникальной идентификации записи.

Сумма
amount True string

Количество разделенного подарка.

Фонд
id True integer

Созданный системой идентификатор для уникального определения фонда.

Состояние
status True string

Состояние подарка.

Возвращаемое значение

Подарок

Создание события

Создает новое событие.

Параметры

Имя Ключ Обязательно Тип Описание
Description
description string

Описание события

Время окончания
end_datetime string

Время окончания события

Идентификатор внешней базы данных
external_database_id string

Назначенный системой уникальный идентификатор записи внешней базой данных. Например, системный идентификатор записи для raiser Edge NXT, contact id for Salesforce

Url-адрес внешней регистрации
external_registration_url string

URL-адрес регистрации события на внешнем веб-сайте

Имя
name True string

Имя события

Время начала
start_datetime string

Время начала события

Timezone
timezone string

Часовой пояс события

Имя
display_name string

Город, штат, страна места проведения

Возвращаемое значение

Event

Создание точки касания

Отправьте новую настраиваемую точку касания в Almabase.

Параметры

Имя Ключ Обязательно Тип Описание
Программа
touchpoint_program True integer

Фильтрует типы по программам касания.

Адрес электронной почты
email email

Идентификатор электронной почты, используемый для действия.

Идентификатор
id integer

Созданный системой идентификатор для уникальной идентификации записи.

Записано в
recorded_at True date-time

Метка времени действия.

Тип
id True integer

Возвращаемое значение

Текст сенсорной точки для создания новой точки касания

Создание фонда

Создает новый фонд.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор внешней базы данных
external_database_id string

Уникальный идентификатор, назначенный системой для фонда внешней базой данных. Например, идентификатор системной записи для raiser Edge NXT, идентификатор объекта для Salesforce

Фонд по умолчанию?
is_default boolean

Указывает, что все расколы с этим фондом не определены, если другие средства не определены на странице предоставления.

Есть ли другой фонд?
is_other_fund boolean

Указывает, что доноры этого фонда дали имя пользовательского фонда.

Имя фонда
name True string

Имя фонда

Возвращаемое значение

Фонд, связанный с разделением подарка.

Список записей

Возвращает список записей.

Параметры

Имя Ключ Обязательно Тип Описание
Поиск по имени
search string

Выполните поиск записей по имени.

Поиск по адресу электронной почты
email_addresses__address string

Поиск записей по адресу электронной почты.

Поиск по идентификатору внешней базы данных
external_database_id string

Поиск записей по идентификатору внешней базы данных.

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 True integer

Созданный системой идентификатор для уникальной идентификации события.

Возвращаемое значение

Список подарков

Возвращает список подарков.

Параметры

Имя Ключ Обязательно Тип Описание
Состояние
status True string

Отфильтруйте подарки на основе состояния.

Предоставление страницы
campaign integer

Созданный системой идентификатор для уникальной идентификации страницы предоставления.

Фильтр по идентификатору группы подарков
group_id uuid

Созданный системой идентификатор для уникальной идентификации группы подарков или списка.

Должен быть пустой номер пакета?
batch_number__isnull boolean

Фильтруйте подарки на основе номера пакета или нет.

Должен ли иметь пустой идентификатор внешней базы данных?
external_database_id__isnull boolean

Фильтруйте подарки на основе уже имеющих внешний идентификатор базы данных или нет. ПРИМЕЧАНИЕ. Подарки, имеющие идентификатор внешней базы данных, уже отправляются во внешнюю базу данных.

Фильтрация по идентификатору внешней базы данных
external_database_id string

Фильтрация подарков на основе идентификатора внешней базы данных.

Фильтрация по электронной почте донора
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

Список подарков, возвращенных для заданных фильтров. Результаты разбиены на страницы.

Список предоставления страниц

Возвращает список предоставления страниц.

Параметры

Имя Ключ Обязательно Тип Описание
Fields
fields array

Разделенный запятыми список полей в ответе.

Возвращаемое значение

Список событий

Возвращает список всех событий.

Параметры

Имя Ключ Обязательно Тип Описание
Поиск по идентификатору внешней базы данных
external_database_id string

Выполните поиск событий по идентификатору внешней базы данных.

Fields
fields array

Разделенный запятыми список полей в ответе.

Возвращаемое значение

Удаление адреса электронной почты записи

Удаление адреса электронной почты записи.

Параметры

Имя Ключ Обязательно Тип Описание
Код записи
record_id True integer

Созданный системой идентификатор для уникальной идентификации записи.

Идентификатор
email_id True integer

Созданный системой идентификатор для уникального определения адреса электронной почты записи.

Формы списка

Получение списка форм.

Параметры

Имя Ключ Обязательно Тип Описание
Fields
fields array

Разделенный запятыми список полей в ответе.

Возвращаемое значение

Триггеры

Если новый подарок успешно или онлайн-платеж по подарку завершается ошибкой.

Активирует, когда новый подарок успешно записан на странице предоставления донором или платеж на подарок не удалось.

При отправке формы или обновлении существующей отправки формы

Активирует при отправке формы или обновлении существующей отправки формы.

При создании, обновлении или удалении сообщения электронной почты в записи

Активирует при создании нового сообщения электронной почты в записи или существующем сообщении электронной почты обновляется или удаляется из записи.

При создании или обновлении записи в Almabase

Активирует при создании новой записи в Almabase или существующей записи.

Если новый подарок успешно или онлайн-платеж по подарку завершается ошибкой.

Активирует, когда новый подарок успешно записан на странице предоставления донором или платеж на подарок не удалось.

Параметры

Имя Ключ Обязательно Тип Описание
Когда
events True string

Список событий для активации потока.

Предоставление страницы
object_id integer

Созданный системой идентификатор для уникальной идентификации страницы предоставления.

Возвращаемое значение

При отправке формы или обновлении существующей отправки формы

Активирует при отправке формы или обновлении существующей отправки формы.

Параметры

Имя Ключ Обязательно Тип Описание
Когда
events True string

Список событий для активации потока.

Form
object_id True integer

Созданный системой идентификатор для уникальной идентификации формы.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

При создании, обновлении или удалении сообщения электронной почты в записи

Активирует при создании нового сообщения электронной почты в записи или существующем сообщении электронной почты обновляется или удаляется из записи.

Параметры

Имя Ключ Обязательно Тип Описание
Когда
events True string

Список событий для активации потока.

Возвращаемое значение

При создании или обновлении записи в Almabase

Активирует при создании новой записи в Almabase или существующей записи.

Параметры

Имя Ключ Обязательно Тип Описание
Когда
events True string

Список событий для активации потока.

Возвращаемое значение

Определения

версия 1. FormApi.FormRead

Form

Имя Путь Тип Описание
Идентификатор
id integer

Созданный системой идентификатор для уникальной идентификации формы.

Имя формы
title string

Имя формы

версия 1. GivingApi.GiftWebhookRecordRead

Запись

Имя Путь Тип Описание
Идентификатор внешней базы данных
external_database_id string

Назначенный системой уникальный идентификатор записи внешней базой данных. Например, системный идентификатор записи для raiser Edge NXT, contact id for Salesforce

Имя (Первое имя)
first_name string

Имя сопоставленной записи

Идентификатор
id integer

Созданный системой идентификатор для уникальной идентификации записи.

Зарегистрирован ли донор в Альмабазе?
is_registered boolean

Указывает, зарегистрирован ли сопоставленная запись или донор, зарегистрированная в Almabase

Фамилия
last_name string

Фамилия сопоставленной записи

версия 1. GivingApi.GiftWebhookResponse

Имя Путь Тип Описание
Сумма
data.amount string

Сумма подарка с двумя десятичными знаками.

Date
data.completed_at date-time

Дата завершения состояния подарка.

Электронная почта донора
data.email email

Идентификатор электронной почты, используемый донором для подарка.

Идентификатор внешней базы данных
data.external_database_id string

Назначенный системой уникальный идентификатор для подарка внешней базой данных.

Идентификатор
data.id integer

Созданный системой идентификатор для уникальной идентификации подарка.

Новая электронная почта?
data.is_email_new boolean

Указывает, существует ли сообщение электронной почты, предоставленное донором, на записях Almabase.

schema
data.mapped_profile.schema v1.GivingApi.GiftWebhookRecordRead

Запись

Mode
data.mode string

Режим подарка.

Имя донора
data.name string

Полное имя донора.

Идентификатор
data.page.id integer

Созданный системой идентификатор для уникальной идентификации страницы предоставления.

Предоставление имени страницы
data.page.name string

Имя связанной страницы предоставления

Состояние
data.status string

Состояние подарка.

Событие, активированное в
time string

Время события.

Тип события
type string

Тип события.

версия 1. GivingApi.LocationRead

Город, используемый донором для подарка.

Имя Путь Тип Описание
Город
city string

Город донора

Короткое название города
city_short_name string

Короткое представление города, например SF

Широта
coordinates.latitude string

Широта расположения

Долгота
coordinates.longitude string

Долгота расположения

Страна
country string

Страна донора

Короткое название страны
country_short_name string

Краткое представление страны, например США

Идентификатор Google Place
gpid string

Идентификатор места, полученный от Google

Город, штат, страна
name string

Город донора. Формат: название города, короткое название штата, короткое название страны

Государство
state string

Состояние донора

Короткое имя состояния
state_short_name string

Короткое представление состояния, например ЦС

версия 1. GivingApi.FormFieldRead

Поле формы

Имя Путь Тип Описание
Ценность
display_value string

Форматируемое значение, введенное респондентами. Например, имя отправки файла.

Имя поля вопроса или формы
label string

Имя поля вопроса или формы в форме

версия 1. GivingApi.FundRead

Фонд, связанный с разделением подарка.

Имя Путь Тип Описание
Идентификатор внешней базы данных
external_database_id string

Уникальный идентификатор, назначенный системой для фонда внешней базой данных. Например, идентификатор системной записи для raiser Edge NXT, идентификатор объекта для Salesforce

Идентификатор
id integer

Созданный системой идентификатор для уникального определения фонда.

Фонд по умолчанию?
is_default boolean

Указывает, что все расколы с этим фондом не определены, если другие средства не определены на странице предоставления.

Есть ли другой фонд?
is_other_fund boolean

Указывает, что доноры этого фонда дали имя пользовательского фонда.

Имя
name string

Имя фонда

версия 1. 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

Идентификатор электронной почты, используемый донором для подарка.

Имя донора
donor_name string

Полное имя донора.

Номер телефона донора
donor_phone_number string

Номер телефона, используемый донором для подарка.

Адрес донора: почтовый индекс
donor_zip_code string

Почтовый индекс адреса, используемого донором для подарка.

Скрыт ли он от таблицы лидеров?
exclude_from_leaderboard boolean

Скрыт ли он от таблицы лидеров?

Идентификатор внешней базы данных
external_database_id string

Назначенный системой уникальный идентификатор для подарка внешней базой данных.

Сообщение о дани
honor_message string

Сообщение о даре дань.

Префикс дани
honor_prefix string

Префикс для дара дань. Доступные варианты: in_honor_of, in_memory_of, in_support_of

Идентификатор
id integer

Созданный системой идентификатор для уникальной идентификации подарка.

Влияние
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
Идентификатор ответа
post_payment_form_entry.id integer

Созданный системой идентификатор для уникальной идентификации отправки формы.

Fields
pre_payment_form_entry.fields array of v1.GivingApi.FormFieldRead
Идентификатор ответа
pre_payment_form_entry.id integer

Созданный системой идентификатор для уникальной идентификации отправки формы.

Сопоставленная запись
profile v1.GivingApi.RecordRead

Сопоставленная запись на Almabase

Ссылка на ссылку на ссылок
referrer_link string

Ссылка на веб-сайт, чтобы определить источник посещения донора. Например, донор посетил кампанию «Предоставление» от Facebook, Google и т. д.

Сумма возврата
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

версия 1. GivingApi.GiftSplitRead

Разделение подарков

Имя Путь Тип Описание
Сумма
amount string

Количество разделенного подарка.

Фонд
fund v1.GivingApi.FundRead

Фонд, связанный с разделением подарка.

Идентификатор
id integer

Созданный системой идентификатор для уникального определения разделения подарка.

версия 1. GivingApi.GivingPageAssociatedWithGift

Страница предоставления, связанная с подарком.

Имя Путь Тип Описание
Идентификатор
id integer

Созданный системой идентификатор для уникальной идентификации страницы предоставления.

Имя
name string

Имя связанной страницы предоставления.

версия 1. GivingApi.GivingPageRead

Предоставление страницы

Имя Путь Тип Описание
Идентификатор
id integer

Созданный системой идентификатор для уникальной идентификации страницы предоставления.

Имя
name string

Имя страницы предоставления

версия 1. GivingApi.InfluencerRead

Ссылка на общедоступную общую папку и приватную панель мониторинга

Имя Путь Тип Описание
Ссылка на панель мониторинга приватного влияния
dashboard_url uri

Частная панель мониторинга донора для мониторинга количества посещений страниц и подарков, влияющих на них

Ссылка на общедоступный общий доступ
page_share_url uri

Общедоступная ссылка на предоставление страницы или кампании донора для отслеживания влияния на посещения страницы предоставления и подарков.

версия 1. GivingApi.PaymentAccountRead

Учетная запись оплаты, связанная с транзакцией, например BBMS, Stripe, PayPal и т. д.

Имя Путь Тип Описание
Идентификатор
id integer

Созданный системой идентификатор для уникальной идентификации учетной записи оплаты.

Имя
name string

Имя учетной записи оплаты.

Gateway
type string

Имя шлюза платежей.

версия 1. GivingApi.RecordRead

Сопоставленная запись на Almabase

Имя Путь Тип Описание
Идентификатор внешней базы данных
external_database_id string

Назначенный системой уникальный идентификатор записи внешней базой данных. Например, системный идентификатор записи для raiser Edge NXT, contact id for Salesforce

Имя (Первое имя)
first_name string

Имя сопоставленной записи

Полное имя
formatted_name string

Полное имя сопоставленной записи

Идентификатор
id integer

Созданный системой идентификатор для уникальной идентификации записи.

Зарегистрирован ли донор в Альмабазе?
is_registered boolean

Указывает, зарегистрирован ли сопоставленная запись или донор, зарегистрированная в Almabase

Фамилия
last_name string

Фамилия сопоставленной записи

URL-адрес рисунка
present_picture uri

URL-адрес рисунка записи

Link
profile_url uri

Ссылка на запись в Almabase

версия 1. GivingApi.TransactionRead

Транзакция онлайн-оплаты, связанная с подарком.

Имя Путь Тип Описание
Учетная запись оплаты
account v1.GivingApi.PaymentAccountRead

Учетная запись оплаты, связанная с транзакцией, например BBMS, Stripe, PayPal и т. д.

Время создания
created_at date-time

Время создания этой транзакции.

Причина сбоя
failure_reason string

Причина сбоя транзакции, возвращаемая шлюзом платежей.

Идентификатор
id uuid

Созданный системой идентификатор для уникальной идентификации транзакции.

Состояние
status integer

Состояние транзакции. - 1 (необработанные) - 2 (успешно) - 3 (сбой) - 4 (ожидание) - 5 (ошибка) ПРИМЕЧАНИЕ. Это состояние связано с состоянием транзакции шлюзом платежей

Идентификатор справочника по шлюзу платежей
transaction_id string

Уникальный идентификатор, созданный шлюзом платежей для идентификации транзакции. Например, идентификатор транзакции Blackbaud Merchant Services (BBMS) или идентификатор транзакции Stripe Charge, PayPal идентификатор транзакции

версия 1. AlmasightsApi.RecordAddOrEdit

Запись на Almabase.

Имя Путь Тип Описание
Идентификатор
id integer

Созданный системой идентификатор для уникальной идентификации записи.

версия 1. AlmasightsApi.TouchpointCustomObjectAdd

Текст сенсорной точки для создания новой точки касания

Имя Путь Тип Описание
Адрес электронной почты
email email

Идентификатор электронной почты, используемый для действия.

Запись
mapped_profile v1.AlmasightsApi.RecordAddOrEdit

Запись на Almabase.

Записано в
recorded_at date-time

Метка времени действия.

Тип
touchpoint_type.id integer

версия 1. RecordApi.LocationRead

Расположение адреса

Имя Путь Тип Описание
Город
city string

Имя города расположения

Страна
country string

Имя страны расположения

Широта
latitude double

Широта расположения

Долгота
longitude double

Долгота расположения

Государство
state string

Имя состояния расположения

версия 1. RecordApi.AddressRead

Address

Имя Путь Тип Описание
Строка 1
line1 string

Строка 1 адреса

Строка 2
line2 string

Строка 2 адреса

schema
location.schema v1.RecordApi.LocationRead

Расположение адреса

Zipcode
zipcode string

Zipcode адреса

версия 1. RecordApi.EmailWebhookRecordRead

Запись

Имя Путь Тип Описание
Идентификатор внешней базы данных
external_database_id string

Назначенный системой уникальный идентификатор записи внешней базой данных. Например, системный идентификатор записи для raiser Edge NXT, contact id for Salesforce

Имя (Первое имя)
first_name string

Имя сопоставленной записи

Идентификатор
id integer

Созданный системой идентификатор для уникальной идентификации записи.

Зарегистрирована ли запись в Almabase?
is_registered boolean

Указывает, зарегистрирована ли сопоставленная запись в Almabase

Фамилия
last_name string

Фамилия сопоставленной записи

версия 1. RecordApi.EmailWebhookResponse

Имя Путь Тип Описание
Электронная почта
data.address email

Адрес электронной почты.

Идентификатор
data.id integer

Созданный системой идентификатор для уникальной идентификации электронной почты.

Основной
data.is_primary boolean

Указывает, является ли адрес электронной почты основным или нет.

schema
data.profile.schema v1.RecordApi.EmailWebhookRecordRead

Запись

Тип электронной почты
data.type string

Тип адреса электронной почты (основной, личной, рабочей и т. д.).

Событие, активированное в
time string

Время события.

Тип события
type string

Тип события.

версия 1. RecordApi.RecordWebhookResponse

Имя Путь Тип Описание
Принадлежность
data.affiliations array of string
Год класса
data.class_year string

Класс года записи

Электронная почта
data.email email

Адрес электронной почты.

Идентификатор внешней базы данных
data.external_database_id string

Назначенный системой уникальный идентификатор записи внешней базой данных. Например, системный идентификатор записи для raiser Edge NXT, contact id for Salesforce

Имя (Первое имя)
data.first_name string

Имя сопоставленной записи

schema
data.home_address.schema v1.RecordApi.AddressRead

Address

Идентификатор
data.id integer

Созданный системой идентификатор для уникальной идентификации записи.

Фамилия
data.last_name string

Фамилия сопоставленной записи

Дата окончания срока действия членства
data.membership_expiry_date date-time

Дата окончания срока действия членства в записи

Имя типа членства
data.membership_type_name string

Имя типа членства записи

Номер мобильного устройства
data.mobile_number string

Номер мобильного устройства записи

schema
data.office_address.schema v1.RecordApi.AddressRead

Address

Номер телефона Office
data.office_phone_number string

Номер телефона Office записи

Номер телефона резиденции
data.residence_phone_number string

Номер телефона резиденции записи

Событие, активированное в
time string

Время события.

Тип события
type string

Тип события.

версия 1. RecordApi.EmailAddressRead

Электронная почта

Имя Путь Тип Описание
Address
address email

Адрес электронной почты

Идентификатор
id integer

Созданный системой идентификатор для уникального определения адреса электронной почты записи.

Занят ли?
is_engaged boolean

Указывает, щелчок или открытие массового сообщения электронной почты или ответ пользователя на одно сообщение электронной почты

Используется для входа?
is_login_email boolean

Указывает, разрешено ли пользователю войти на платформу с помощью этого адреса электронной почты.

Является ли первичный?
is_primary boolean

Основное сообщение электронной почты используется для отправки автоматических сообщений электронной почты, активированных системой. Он также используется для отправки массовой электронной почты в запись. Обязательно, чтобы только одна электронная почта была основной.

Проверяется пользователем?
is_verified boolean

Укажите, был ли пользователь проверен, что он владеет электронной почтой.

source
source string

Источник указывает, как электронная почта добавляется в базу данных.

статус
status string
Тип
type string

Тип сообщения электронной почты

версия 1. RecordApi.RecordRead

запись

Имя Путь Тип Описание
Адреса электронной почты
email_addresses array of v1.RecordApi.EmailAddressRead

Список адресов электронной почты профиля

Идентификатор внешней базы данных
external_database_id string

Назначенный системой уникальный идентификатор записи внешней базой данных. Например, системный идентификатор записи для raiser Edge NXT, contact id for Salesforce

Имя (Первое имя)
first_name string

Имя записи.

Полное имя
formatted_name string

Полное имя записи.

Идентификатор
id integer

Созданный системой идентификатор для уникальной идентификации записи.

Зарегистрировано ли в Almabase?
is_registered boolean

Указывает, зарегистрирована ли запись или донор, зарегистрированная в Almabase

Фамилия
last_name string

Фамилия записи.

URL-адрес рисунка
present_picture uri

URL-адрес рисунка записи

Link
record_url uri

Ссылка на запись в Almabase

версия 1. EventApi.ContactPersonRead

Контактное лицо события

Имя Путь Тип Описание
Адрес электронной почты
email email

Электронная почта контактного лица

Идентификатор
id integer

Созданный системой идентификатор для уникального идентификации контактного лица.

Имя
name string

Имя контактного лица

Номер телефона
phone_number string

Номер телефона контактного лица

версия 1. EventApi.EventRead

Event

Имя Путь Тип Описание
Description
description string

Описание события

Время окончания
end_datetime string

Время окончания события

Идентификатор внешней базы данных
external_database_id string

Назначенный системой уникальный идентификатор записи внешней базой данных. Например, системный идентификатор записи для raiser Edge NXT, contact id for Salesforce

Url-адрес внешней регистрации
external_registration_url string

URL-адрес регистрации события на внешнем веб-сайте

Идентификатор
id integer

Созданный системой идентификатор для уникальной идентификации события.

Имя
name string

Имя события

Время начала
start_datetime string

Время начала события

Timezone
timezone string

Часовой пояс события