Skip to content

Schema Reference

The application schema is used to configure the objects returned from a connector.

Note

  • The Account Schema tab is used to define the attributes for each object type in the application being configured. The schema attributes can be defined as Entitlement or Multi-Valued. Refer to Managing Source Account Schemas for more information.

  • The schema attributes that are not present by default must be defined as strings if not specified.

The Givebutter connector uses the following default correlation and object configurations.

Default Account Schema

Each source supports a variety of details, or attributes, about each user who has an account, such as their name, email address, manager name, and location.

The set of account attributes each source stores and how they're organized is known as the account's schema. To best represent your data, you can configure sources to use an account schema matching the one you use in the external connector. Refer to Managing Source Account Schemas for more information.

Default Account ID

SailPoint requires that certain attributes remain in your configuration. These attributes are referred to as account IDs.

Caution

Changing the attribute marked as the account ID after aggregating accounts can result in duplicate accounts being created. To avoid this, either reset the accounts on this source before editing the account ID attribute or edit the account ID attribute before aggregating accounts.

To resolve issues caused by changing account IDs, reconfigure them to their default values.

The following table lists the default account IDs for this connector:

Account ID Schema Object Type
id Account (Contact)

Default Account Attributes

The Givebutter connector supports the following default account schema attributes and customer configurable attributes. The attributes must be defined as strings if not specified.

Attribute Name Description
id Unique identifier for the contact
external_id External identifier for the contact
contact_since Date the contact was first added
type Type of the contact record
prefix Salutation of the contact
first_name First name of the contact
preferred_name Preferred name of the contact
middle_name Middle name of the contact
last_name Last name of the contact
suffix Suffix of the contact's name
gender Gender of the contact
pronouns Pronouns of the contact
dob Date of birth of the contact
company Company field of the contact
employer Employer of the contact
company_name Company name of the contact
title Job title of the contact
website_url Website URL of the contact
twitter_url Twitter URL of the contact
linkedin_url LinkedIn URL of the contact
facebook_url Facebook URL of the contact
tiktok_url TikTok URL of the contact
instagram_url Instagram URL of the contact
emails_type Type of each email address on the contact - one of home, work, other
emails_value Value of each email address on the contact
phones_type Type of each phone number on the contact - one of mobile, home, work, other
phones_value Value of each phone number on the contact
primary_email Primary email address of the contact
primary_phone Primary phone number of the contact
note Note associated with the contact
addresses_address_1 Address line 1 for each address on the contact
addresses_address_2 Address line 2 for each address on the contact
addresses_city City for each address on the contact
addresses_state State for each address on the contact
addresses_zipcode Zipcode for each address on the contact
addresses_country Country for each address on the contact
addresses_type Type for each address on the contact - one of home, work, other
addresses_is_primary Stores boolean true/false, whether each address is the primary address
addresses_created_at Timestamp when each address was created
addresses_updated_at Timestamp when each address was last updated
primary_address_address_1 Address line 1 of the contact's primary address
primary_address_address_2 Address line 2 of the contact's primary address
primary_address_city City of the contact's primary address
primary_address_state State of the contact's primary address
primary_address_zipcode Zipcode of the contact's primary address
primary_address_country Country of the contact's primary address
primary_address_type Type of the contact's primary address
primary_address_is_primary Stores boolean true/false, whether the primary address record is marked primary
primary_address_created_at Timestamp when the primary address was created
primary_address_updated_at Timestamp when the primary address was last updated
last_donation_amount Amount of the contact's last donation
stats_total_contributions Total contributions made by the contact
stats_recurring_contributions Recurring contributions made by the contact
tags Tags applied to the contact
custom_fields Custom fields defined on the contact
external_ids_id ID of each external identifier record on the contact
external_ids_label Label of each external identifier record on the contact
external_ids_external_id Value of each external identifier record on the contact
external_ids_created_at Timestamp when each external identifier record was created
external_ids_updated_at Timestamp when each external identifier record was last updated
is_email_subscribed Stores boolean true/false, whether the contact is subscribed to email communications
is_phone_subscribed Stores boolean true/false, whether the contact is subscribed to phone communications
is_address_subscribed Stores boolean true/false, whether the contact is subscribed to postal communications
email_opt_in Stores boolean true/false, whether the contact has opted in to email
sms_opt_in Stores boolean true/false, whether the contact has opted in to SMS
address_unsubscribed_at Timestamp when the contact unsubscribed from postal communications
archived_at Timestamp when the contact was archived
created_at Timestamp when the contact was created
updated_at Timestamp when the contact was last updated
salutation_name Salutation name of the contact
point_of_contact_id Id of the point of contact linked to this record
point_of_contact_type Type of the point of contact record
point_of_contact_prefix Prefix of the point of contact
point_of_contact_first_name First name of the point of contact
point_of_contact_middle_name Middle name of the point of contact
point_of_contact_last_name Last name of the point of contact
point_of_contact_suffix Suffix of the point of contact
point_of_contact_gender Gender of the point of contact
point_of_contact_pronouns Pronouns of the point of contact
point_of_contact_dob Date of birth of the point of contact
point_of_contact_employer Employer of the point of contact
point_of_contact_title Job title of the point of contact
point_of_contact_twitter_url Twitter URL of the point of contact
point_of_contact_linkedin_url LinkedIn URL of the point of contact
point_of_contact_facebook_url Facebook URL of the point of contact
point_of_contact_tiktok_url TikTok URL of the point of contact
point_of_contact_instagram_url Instagram URL of the point of contact
point_of_contact_website_url Website URL of the point of contact
point_of_contact_primary_email Primary email of the point of contact
point_of_contact_primary_phone Primary phone of the point of contact
point_of_contact_is_email_subscribed Stores boolean true/false, whether the point of contact is subscribed to email communications
point_of_contact_is_phone_subscribed Stores boolean true/false, whether the point of contact is subscribed to phone communications
point_of_contact_is_address_subscribed Stores boolean true/false, whether the point of contact is subscribed to postal communications
point_of_contact_address_unsubscribed_at Timestamp when the point of contact unsubscribed from postal communications
point_of_contact_archived_at Timestamp when the point of contact was archived
point_of_contact_created_at Timestamp when the point of contact was created
point_of_contact_updated_at Timestamp when the point of contact was last updated
point_of_contact_first_time_supporter_at Timestamp when the point of contact became a first-time supporter
associated_companies_id Id of the company associated to the contact
associated_companies_name Name of the company associated to the contact, used as the Entitlement value
associated_companies_name_display Display name of the company associated to the contact
associated_companies_type Type of each company associated to the contact
associated_companies_title Title of the contact at each associated company
associated_companies_twitter_url Twitter URL of each associated company
associated_companies_linkedin_url LinkedIn URL of each associated company
associated_companies_facebook_url Facebook URL of each associated company
associated_companies_tiktok_url TikTok URL of each associated company
associated_companies_instagram_url Instagram URL of each associated company
associated_companies_website_url Website URL of each associated company
associated_companies_image_url Image URL of each associated company
associated_companies_primary_email Primary email of each associated company
associated_companies_primary_phone Primary phone of each associated company
associated_companies_is_email_subscribed Stores boolean true/false, whether each associated company is subscribed to email communications
associated_companies_is_phone_subscribed Stores boolean true/false, whether each associated company is subscribed to phone communications
associated_companies_is_address_subscribed Stores boolean true/false, whether each associated company is subscribed to postal communications
associated_companies_address_unsubscribed_at Timestamp when each associated company unsubscribed from postal communications
associated_companies_note Note on each associated company
associated_companies_archived_at Timestamp when each associated company was archived
associated_companies_created_at Timestamp when each associated company was created
associated_companies_updated_at Timestamp when each associated company was last updated
associated_companies_first_time_supporter_at Timestamp when each associated company became a first-time supporter
associated_companies_addresses_id Id of each address on each associated company
associated_companies_addresses_account_id Account id of each address on each associated company
associated_companies_addresses_name Name of each address on each associated company
associated_companies_addresses_address_1 Address line 1 of each address on each associated company
associated_companies_addresses_address_2 Address line 2 of each address on each associated company
associated_companies_addresses_city City of each address on each associated company
associated_companies_addresses_state State of each address on each associated company
associated_companies_addresses_zipcode Zipcode of each address on each associated company
associated_companies_addresses_country Country of each address on each associated company
associated_companies_addresses_type Type of each address on each associated company
associated_companies_addresses_is_primary Stores boolean true/false, whether each address on each associated company is the primary address
associated_companies_addresses_created_at Timestamp when each address on each associated company was created
associated_companies_addresses_updated_at Timestamp when each address on each associated company was last updated
associated_companies_primary_address_id Id of the primary address of each associated company
associated_companies_primary_address_account_id Account id of the primary address of each associated company
associated_companies_primary_address_name Name of the primary address of each associated company
associated_companies_primary_address_address_1 Address line 1 of the primary address of each associated company
associated_companies_primary_address_address_2 Address line 2 of the primary address of each associated company
associated_companies_primary_address_city City of the primary address of each associated company
associated_companies_primary_address_state State of the primary address of each associated company
associated_companies_primary_address_zipcode Zipcode of the primary address of each associated company
associated_companies_primary_address_country Country of the primary address of each associated company
associated_companies_primary_address_type Type of the primary address of each associated company
associated_companies_primary_address_is_primary Stores boolean true/false, whether the primary address record of each associated company is marked primary
associated_companies_primary_address_created_at Timestamp when the primary address of each associated company was created
associated_companies_primary_address_updated_at Timestamp when the primary address of each associated company was last updated