/ to search
Documentation Tenant Settings

Tenant Settings

Workspace Settings Reference

This reference lists the confirmed sections, fields, and important implementation notes for Workspace Settings.

Access and scope

  • Workspace Settings is a tenant-admin page.
  • The page heading and navigation label are both Workspace Settings.
  • The page stores most values directly on the tenant record, with campaign UTM defaults stored in the tenant settings JSON and Prospect Intelligence values stored in the prospect_intelligence_settings table.

Workspace

Confirmed settings:

  • Workspace Name
  • Timezone

Behavior notes:

  • The workspace name should not be changed casually. The UI warns that it may be used in public URLs and integration settings.
  • The timezone is optional.
  • The timezone is used as the default timezone for events and programs when they do not define their own timezone.

Domain

Confirmed settings and content:

  • Custom Domain
  • Email Sender Preview
  • DNS Setup
  • What Happens Next

Behavior notes:

  • The UI is explicitly designed for a branded subdomain.
  • Root domains are not supported in this flow.
  • The saved value is normalized to lowercase and stripped of protocol and trailing slash.
  • Public donation, event, program, and member routes support tenant-domain variants.
  • The default Altrinum URL remains usable until the custom domain is connected.
  • Stripe webhooks still use the secure hooks domain shown in the Stripe section, not the public custom domain.

Branding

Confirmed settings:

  • Logo
  • Primary Color
  • Secondary Color
  • Contact Email
  • Contact Phone
  • Website
  • Header Content
  • Footer Content

Behavior notes:

  • Public pages resolve tenant branding through the public branding profile.
  • Tenant-branded email layouts also use the tenant logo and colors.
  • If custom header content is blank, public pages show the standard brand mark and optional website link.
  • If custom footer content is blank, public pages fall back to the organization name and contact email.
  • There is no separate favicon field in Workspace Settings.

Google Tracking

Confirmed settings:

  • Google Tracking ID

Accepted values:

  • GTM-...
  • Google tag IDs beginning with G-, GT-, AW-, or DC-

Behavior notes:

  • The value is normalized before save.
  • Public layouts include the tenant tracking tag.
  • Member-facing layouts also use the tenant tracking tag.
  • Tracking scripts are still gated by the cookie-consent logic used by the application.

Campaign Email UTM Tracking

Confirmed settings:

  • Enable automatic UTM tagging for campaign emails
  • Default UTM Source
  • Default UTM Medium
  • UTM Campaign Pattern
  • UTM Content Pattern
  • UTM Term Pattern

Supported pattern tokens:

  • {campaign_id}
  • {campaign_name}
  • {campaign_slug}
  • {tenant_id}
  • {tenant_name}
  • {tenant_slug}
  • {date}

Behavior notes:

  • Tenant defaults apply only when campaign-level behavior does not override them.
  • Existing UTM parameters are preserved.
  • Signed links, unsubscribe links, preferences links, and member-access links are skipped.
  • The tagging logic applies to marketing campaign email rendering, not to every possible link in the platform.

Tax Receipts and Acknowledgments

Confirmed sections:

  • Organization Eligibility
  • Canada Issuer Profile
  • U.S. Acknowledgment Profile

Confirmed fields include:

  • Canadian capability toggle
  • U.S. capability toggle
  • We are a registered charity (Canada)
  • Charity registration number
  • Legal name (as registered with CRA)
  • charitable address fields
  • Receipt issued location
  • Receipt number prefix
  • Authorized signatory name
  • Authorized signatory title
  • Signature image
  • Legal name for U.S. acknowledgments
  • Employer Identification Number (EIN)

Behavior notes:

  • The page prevents saving both Canadian and U.S. document capability at the same time.
  • Canadian receipting fields are required only when the workspace is marked as a registered Canadian charity.
  • Receipt numbering is sequential per tenant and may use the optional prefix.
  • Canadian issuer details are used by donation receipt and annual receipt generation.
  • U.S. acknowledgment support exists in the codebase, but the UI copy still frames parts of it as future-facing. Teams should validate the exact compliance workflow before relying on it.
  • Giving-form recurring receipt schedule is feature-specific and is not controlled here.

Prospect Intelligence

Confirmed settings:

  • Enable Prospect Intelligence
  • Major gift threshold
  • Use leadership annual giving
  • Leadership annual threshold
  • Lapsed after days
  • Second-gift window start
  • Second-gift window end
  • Planned giving relationship years
  • Planned giving consecutive years
  • Refresh Prospect Scores
  • Score freshness

Behavior notes:

  • The default mode saved by Workspace Settings is simple.
  • Workspace Settings exposes only part of the underlying settings model.
  • Saving thresholds does not refresh persisted prospect scores.
  • Refreshing prospect scores is a separate action.

AI

Confirmed settings and read-only fields:

  • Enable Ask Altrinum
  • Enable AI Ask Optimization
  • Maximum Ask Adjustment (%)
  • Minimum Prior Gifts
  • Current AI Credit Balance
  • Lifetime AI Credits Purchased
  • Lifetime AI Credits Used

Behavior notes:

  • Enabling Ask Altrinum controls whether the tenant sees the Ask Altrinum navigation item.
  • AI Ask Optimization runtime controls are stored in the tenant settings JSON.
  • Public donation rendering may use the persisted explanation_factors_json.ask_optimization recommendation for eligible logged-in donors.
  • Giving-form amount_options remain the default and fallback suggested-amount source.
  • The page does not provide AI provider selection here.
  • Credit values are displayed read-only in this tenant-facing settings page.

Organization Address

Confirmed settings:

  • Address Line 1
  • Address Line 2
  • City
  • State
  • Zip
  • Country
  • Phone
  • Tax Number

Behavior notes:

  • The section description says this address is used for issuing invoices.
  • If charitable address fields are blank, some tenant-branded email footer logic can also fall back to the organization address.
  • This address is separate from the Canada issuer profile used for charitable receipts.

Payments

Confirmed processor choices:

  • Stripe
  • Moneris
  • BBMS New checkout (EAP)

Behavior notes:

  • The selected value is stored as the tenant payment processor.
  • Public donation, event, and program payment flows read tenant payment settings from this selection.
  • Stripe and Moneris expose connection test actions in Workspace Settings.
  • BBMS New checkout is labeled EAP or beta in the UI and should be treated accordingly.

Stripe Settings

Confirmed fields:

  • Stripe Account ID
  • Stripe Publishable Key
  • Stripe Secret Key
  • Stripe Webhook Signing Secret
  • Test Stripe Connection

Behavior notes:

  • The connection test retrieves Stripe balance and optionally checks the account ID.
  • Stripe is considered configured only when both publishable and secret keys are present.
  • The webhook setup instructions list required and optional Stripe events.

Moneris Settings

Confirmed fields:

  • Store ID
  • API Token
  • Checkout ID
  • Hosted Tokenization Profile ID (Legacy)
  • Environment
  • Connection Status
  • Test Moneris Connection

Behavior notes:

  • The connection test performs a tiny preload ticket request rather than a live charge.
  • Workspace Settings stores the last verification timestamp and last error.
  • One-time Moneris checkout is confirmed in the public donation, event, and program flows.
  • The recurring Moneris charge path is not fully implemented in the gateway code and still needs operational validation.

BBMS New checkout (EAP)

Confirmed fields:

  • Environment ID
  • Payment Configuration ID
  • API Base URL
  • OAuth Client ID
  • OAuth Client Secret
  • Subscription Key
  • Webhook Shared Secret
  • OAuth Token URL
  • Capture Path

Behavior notes:

  • The section is explicitly labeled beta.
  • Checkout remains blocked until required values are present.
  • The donation BBMS flow uses the tenant primary color and organization name for inline checkout branding.