# Discipleship API availability
Source: https://docs.thefaithapp.com/api-reference/discipleship
Understand the current public integration boundary for TheFaithApp Discipleship.
# Discipleship API availability
Discipleship is available in TheFaithApp's first-party admin dashboard and
member apps. It is **not currently included in the supported public partner
`v1` API**.
That means a partner app cannot yet use the public API to load pathways,
submit quizzes, update progress, manage mentorship, or participate in private
formation practices.
Do not call admin dashboard routes or internal mobile routes from a partner
app. They use first-party authentication, permissions, and privacy rules and
may change without a partner API version transition.
## Supported today
| Need | Recommended approach |
| --------------------------------------------------- | ------------------------------------------------------------ |
| Church staff create and manage Discipleship content | Use the TheFaithApp admin dashboard |
| Members take classes and use formation practices | Use the TheFaithApp member app |
| A person verifies a completion certificate | Open the public verification link printed on the certificate |
| A partner app needs supported TheFaithApp data | Use only endpoints listed in this `v1` API reference |
Certificate verification links are public product links. A person does not
need dashboard access to verify a certificate. This does not make the wider
Discipleship data model a public API.
## Why the boundary matters
Discipleship includes unusually sensitive data: private journals, spiritual
goals, Examen responses, fast choices, Rule of Life commitments, and mentor
check-ins. A public contract needs explicit scopes, consent behavior, owner-only
authorization, retention guarantees, and safe error responses before it can be
offered to partners.
## What not to do
* Do not copy a bearer token or cookie from the first-party apps.
* Do not scrape the admin dashboard or mobile responses.
* Do not store correct quiz answers in a client bundle.
* Do not recreate staff access to private member formation data.
* Do not treat an internal route path as a stable API contract.
## Prepare for a future integration
You can design your application so a future supported API is easier to adopt:
1. Use [Hosted Auth](/api-reference/hosted-auth) for member identity where your
current integration already uses supported `v1` endpoints.
2. Keep church and member identifiers opaque; do not derive meaning from them.
3. Separate shared learning progress from private spiritual reflection in your
own data model.
4. Build explicit consent and revocation into any feature that shares formation
data.
5. Subscribe to the [Changelog](/changelog) for new public API capabilities.
Hosted Auth does not grant access to Discipleship by itself. It is listed
here only as the supported identity pattern for existing partner APIs.
## Requesting access
If Discipleship integration is important to your church or product, contact
[support@thefaithapp.com](mailto:support@thefaithapp.com) with the member
workflow, data you need, and how you plan to protect private formation data.
That information helps shape a safe future public contract.
# Batch Track Analytics
Source: https://docs.thefaithapp.com/api-reference/endpoints/analytics/batch-track-analytics
/api-reference/openapi.json post /v1/analytics/batch-track
Records several analytics events in one request. Each item returns an independent success or failure result.
# End Analytics Session
Source: https://docs.thefaithapp.com/api-reference/endpoints/analytics/end-analytics-session
/api-reference/openapi.json post /v1/analytics/session/end
Closes an analytics session owned by the authenticated member and church.
# Start Analytics Session
Source: https://docs.thefaithapp.com/api-reference/endpoints/analytics/start-analytics-session
/api-reference/openapi.json post /v1/analytics/session/start
Starts or reuses a client-generated analytics session.
# Track Content View
Source: https://docs.thefaithapp.com/api-reference/endpoints/analytics/track-content-view
/api-reference/openapi.json post /v1/analytics/track/content-view
Records a view of church content.
# Track Feature Usage
Source: https://docs.thefaithapp.com/api-reference/endpoints/analytics/track-feature-usage
/api-reference/openapi.json post /v1/analytics/track/feature-usage
Records an action in a named product feature.
# Track Media Play
Source: https://docs.thefaithapp.com/api-reference/endpoints/analytics/track-media-play
/api-reference/openapi.json post /v1/analytics/track/media-play
Records media playback.
# Track Notification Clicked
Source: https://docs.thefaithapp.com/api-reference/endpoints/analytics/track-notification-clicked
/api-reference/openapi.json post /v1/analytics/notifications/track/clicked
Records that a notification was clicked. Duplicate events are handled idempotently.
# Track Notification Delivered
Source: https://docs.thefaithapp.com/api-reference/endpoints/analytics/track-notification-delivered
/api-reference/openapi.json post /v1/analytics/notifications/track/delivered
Records that a notification was delivered. Duplicate events are handled idempotently.
# Track Notification Opened
Source: https://docs.thefaithapp.com/api-reference/endpoints/analytics/track-notification-opened
/api-reference/openapi.json post /v1/analytics/notifications/track/opened
Records that a notification was opened. Duplicate events are handled idempotently.
# Track Page View
Source: https://docs.thefaithapp.com/api-reference/endpoints/analytics/track-page-view
/api-reference/openapi.json post /v1/analytics/track/page-view
Records a page view.
# Get Church Branches
Source: https://docs.thefaithapp.com/api-reference/endpoints/churches/get-church-branches
/api-reference/openapi.json get /v1/branches
Retrieve a paginated list of branches for the authenticated user's church. Supports optional pagination.
# Get Church Name
Source: https://docs.thefaithapp.com/api-reference/endpoints/churches/get-church-name
/api-reference/openapi.json get /v1/client/{uuid}/name
Returns the display name for a church public UUID.
# Get Church Profile
Source: https://docs.thefaithapp.com/api-reference/endpoints/churches/get-church-profile
/api-reference/openapi.json get /v1/church
Returns the authenticated member’s church profile, social links, branches, gatherings, and hosted action URLs. Open `church.giving_link` for member giving.
# Get Public Church Profile
Source: https://docs.thefaithapp.com/api-reference/endpoints/churches/get-public-church-profile
/api-reference/openapi.json get /v1/churches/public/{uuid}
Returns the public church profile used before a member subscribes or switches context.
# List Churches
Source: https://docs.thefaithapp.com/api-reference/endpoints/churches/list-churches
/api-reference/openapi.json get /v1/churches
Returns the public church directory with optional search and pagination.
# Comment On A Community Group Post
Source: https://docs.thefaithapp.com/api-reference/endpoints/community-groups/comment-on-a-community-group-post
/api-reference/openapi.json post /v1/community-groups/{groupId}/feed/posts/{postId}/comments
Adds a comment to a post visible to an active member of the group.
# Create A Community Group Leader Note
Source: https://docs.thefaithapp.com/api-reference/endpoints/community-groups/create-a-community-group-leader-note
/api-reference/openapi.json post /v1/community-groups/{groupId}/leader-notes
Creates a private group leader note, optionally associated with an active group member.
# Create A Community Group Post
Source: https://docs.thefaithapp.com/api-reference/endpoints/community-groups/create-a-community-group-post
/api-reference/openapi.json post /v1/community-groups/{groupId}/feed/posts
Publishes a discussion or, for authorized group leaders, an announcement.
# Create A Community Group Study Guide
Source: https://docs.thefaithapp.com/api-reference/endpoints/community-groups/create-a-community-group-study-guide
/api-reference/openapi.json post /v1/community-groups/{groupId}/study-guides
Publishes a study guide for the group. Only group leaders, co-leaders, and hosts may perform this action.
# Get A Community Group
Source: https://docs.thefaithapp.com/api-reference/endpoints/community-groups/get-a-community-group
/api-reference/openapi.json get /v1/community-groups/{groupId}
Returns one active community group in the member’s church together with the member’s current membership state.
# Get Community Group Feed
Source: https://docs.thefaithapp.com/api-reference/endpoints/community-groups/get-community-group-feed
/api-reference/openapi.json get /v1/community-groups/{groupId}/feed
Returns group posts, comments, and study guides for an active group member.
# Join A Community Group
Source: https://docs.thefaithapp.com/api-reference/endpoints/community-groups/join-a-community-group
/api-reference/openapi.json post /v1/community-groups/{groupId}/join
Joins an open group or submits an approval request for a request-to-join group.
# Leave A Community Group
Source: https://docs.thefaithapp.com/api-reference/endpoints/community-groups/leave-a-community-group
/api-reference/openapi.json delete /v1/community-groups/{groupId}/membership
Ends the authenticated member’s membership and synchronizes linked group chat access.
# List Community Group Leader Notes
Source: https://docs.thefaithapp.com/api-reference/endpoints/community-groups/list-community-group-leader-notes
/api-reference/openapi.json get /v1/community-groups/{groupId}/leader-notes
Returns private leader notes for the selected group. Only group leaders, co-leaders, and hosts may view them.
# List Community Groups
Source: https://docs.thefaithapp.com/api-reference/endpoints/community-groups/list-community-groups
/api-reference/openapi.json get /v1/community-groups
Lists active community groups in the authenticated member’s church with membership state and optional filters.
# Record Community Group Attendance
Source: https://docs.thefaithapp.com/api-reference/endpoints/community-groups/record-community-group-attendance
/api-reference/openapi.json post /v1/community-groups/{groupId}/attendance
Creates or updates attendance records for active group members. Only group leaders, co-leaders, and hosts may perform this action.
# Record Community Group Attendance (Compatibility)
Source: https://docs.thefaithapp.com/api-reference/endpoints/community-groups/record-community-group-attendance-compatibility
/api-reference/openapi.json get /v1/community-groups/{groupId}/attendance
Compatibility alias for recording attendance. This GET mutation is deprecated; integrations should use POST on the same path.
# Get Communication Preferences
Source: https://docs.thefaithapp.com/api-reference/endpoints/community-preferences-&-research/get-communication-preferences
/api-reference/openapi.json get /v1/community/communication-preferences
Returns quiet hours, timezone, and topic-level community notification preferences for the authenticated member.
# Get Community Summary
Source: https://docs.thefaithapp.com/api-reference/endpoints/community-preferences-&-research/get-community-summary
/api-reference/openapi.json get /v1/community/summary
Returns the authenticated member's group counts, mutual-aid availability, research-pilot status, and shared-resource availability.
# Get Research Consent
Source: https://docs.thefaithapp.com/api-reference/endpoints/community-preferences-&-research/get-research-consent
/api-reference/openapi.json get /v1/community/research-consent
Returns consent and eligibility information for opt-in community research pilots.
# Grant Or Update Research Consent
Source: https://docs.thefaithapp.com/api-reference/endpoints/community-preferences-&-research/grant-or-update-research-consent
/api-reference/openapi.json put /v1/community/research-consent
Opts the authenticated member into one or more enabled research pilots after explicit acceptance of the consent terms.
# Update Communication Preferences
Source: https://docs.thefaithapp.com/api-reference/endpoints/community-preferences-&-research/update-communication-preferences
/api-reference/openapi.json put /v1/community/communication-preferences
Updates quiet hours, timezone, and topic-level community notification preferences.
# Withdraw Research Consent
Source: https://docs.thefaithapp.com/api-reference/endpoints/community-preferences-&-research/withdraw-research-consent
/api-reference/openapi.json delete /v1/community/research-consent
Withdraws the authenticated member from all community research pilots.
# Get Audio Sermons
Source: https://docs.thefaithapp.com/api-reference/endpoints/content/get-audio-sermons
/api-reference/openapi.json get /v1/audios
Retrieve a paginated list of audio sermons for the authenticated user's church. Supports optional search and pagination.
# Get Devotionals
Source: https://docs.thefaithapp.com/api-reference/endpoints/content/get-devotionals
/api-reference/openapi.json get /v1/devotionals
Retrieve devotionals for the authenticated user's church. When X-Client-Date header is provided, returns a single devotional for that date with metadata. Otherwise, returns a paginated list of devotionals.
# Get Live Streamings
Source: https://docs.thefaithapp.com/api-reference/endpoints/content/get-live-streamings
/api-reference/openapi.json get /v1/streamings
Retrieve the current live video and audio streaming information for the authenticated user's church.
# Get Sermon Chapters
Source: https://docs.thefaithapp.com/api-reference/endpoints/content/get-sermon-chapters
/api-reference/openapi.json get /v1/media/{mediaId}/chapters
Fetch published chapter markers for a sermon in the authenticated member's church. Returns data: null when no published chapters are available.
# Get Sermon Insights
Source: https://docs.thefaithapp.com/api-reference/endpoints/content/get-sermon-insights
/api-reference/openapi.json get /v1/media/{mediaId}/insights
Fetch published sermon summary, key points, scripture references, reflection questions, and discussion prompts for a sermon in the authenticated member's church. Returns data: null when no published insights are available.
# Get Sermon Transcript
Source: https://docs.thefaithapp.com/api-reference/endpoints/content/get-sermon-transcript
/api-reference/openapi.json get /v1/media/{mediaId}/transcript
Fetch the published synced transcript for an audio or uploaded video sermon in the authenticated member's church. Returns data: null when no published transcript is available.
# Get Single Devotional
Source: https://docs.thefaithapp.com/api-reference/endpoints/content/get-single-devotional
/api-reference/openapi.json get /v1/devotionals/{id}
Fetches a full devotional payload by ID.
# Get Video Sermons
Source: https://docs.thefaithapp.com/api-reference/endpoints/content/get-video-sermons
/api-reference/openapi.json get /v1/videos
Retrieve a paginated list of video sermons for the authenticated user's church. Supports optional search and pagination.
# List Church YouTube Videos
Source: https://docs.thefaithapp.com/api-reference/endpoints/content/list-church-youtube-videos
/api-reference/openapi.json get /v1/youtube/videos
Returns videos from the authenticated church's configured YouTube playlist or channel.
# List Media by Category
Source: https://docs.thefaithapp.com/api-reference/endpoints/content/list-media-by-category
/api-reference/openapi.json get /v1/media/category/{categoryId}
Returns paginated church media in a category. `client_id` is currently required in addition to the authenticated church context.
# List Videos from a YouTube URL
Source: https://docs.thefaithapp.com/api-reference/endpoints/content/list-videos-from-a-youtube-url
/api-reference/openapi.json get /v1/youtube/external
Resolves a public YouTube playlist or channel URL and returns its videos in the standard media shape.
# Get Current User
Source: https://docs.thefaithapp.com/api-reference/endpoints/core-experience/get-current-user
/api-reference/openapi.json get /v1/user
Returns the authenticated member profile together with the active church context.
# Get Home Feed
Source: https://docs.thefaithapp.com/api-reference/endpoints/core-experience/get-home-feed
/api-reference/openapi.json get /v1/home
Loads the member-facing home payload, including church context, content, and the latest bulletin.
# Set Active Church
Source: https://docs.thefaithapp.com/api-reference/endpoints/core-experience/set-active-church
/api-reference/openapi.json post /v1/set-client-id
Moves the authenticated member into a church context. The selected church must match the API key used for subsequent requests.
# Subscribe to Church
Source: https://docs.thefaithapp.com/api-reference/endpoints/core-experience/subscribe-to-church
/api-reference/openapi.json post /v1/subscribe
Subscribes the authenticated TheFaithApp member to the church represented by the client API key and stores the device FCM token for push notifications.
# Update Member Profile
Source: https://docs.thefaithapp.com/api-reference/endpoints/core-experience/update-member-profile
/api-reference/openapi.json put /v1/member
Canonical alias for `PUT /v1/member/details`. Updates fields on the authenticated member profile.
# Update Member Profile Details (Legacy)
Source: https://docs.thefaithapp.com/api-reference/endpoints/core-experience/update-member-profile-details-legacy
/api-reference/openapi.json put /v1/member/details
Compatibility route for updating the authenticated member profile. New integrations should use `PUT /v1/member`.
# Add Bookmark
Source: https://docs.thefaithapp.com/api-reference/endpoints/engagement/add-bookmark
/api-reference/openapi.json post /v1/bookmarks
Adds a devotional to the authenticated member's bookmarks.
# Add Favorite
Source: https://docs.thefaithapp.com/api-reference/endpoints/engagement/add-favorite
/api-reference/openapi.json post /v1/favorites
Adds a media item to the authenticated member's favorites.
# List Bookmarks
Source: https://docs.thefaithapp.com/api-reference/endpoints/engagement/list-bookmarks
/api-reference/openapi.json get /v1/bookmarks
Lists the devotional bookmarks saved by the authenticated member.
# List Favorites
Source: https://docs.thefaithapp.com/api-reference/endpoints/engagement/list-favorites
/api-reference/openapi.json get /v1/favorites
Lists the favorite media items saved by the authenticated member.
# Remove Bookmark
Source: https://docs.thefaithapp.com/api-reference/endpoints/engagement/remove-bookmark
/api-reference/openapi.json delete /v1/bookmarks
Removes a devotional from the authenticated member's bookmarks.
# Remove Favorite
Source: https://docs.thefaithapp.com/api-reference/endpoints/engagement/remove-favorite
/api-reference/openapi.json delete /v1/favorites
Removes a media item from the authenticated member's favorites.
# Cancel Event Registration
Source: https://docs.thefaithapp.com/api-reference/endpoints/events-&-volunteers/cancel-event-registration
/api-reference/openapi.json delete /v1/events/{eventId}/registrations/{registrationId}
Cancels a registration owned by the authenticated member.
# Cancel Volunteer Signup
Source: https://docs.thefaithapp.com/api-reference/endpoints/events-&-volunteers/cancel-volunteer-signup
/api-reference/openapi.json delete /v1/volunteer/signups/{id}
Cancels a volunteer signup owned by the authenticated member.
# Check In Event Registration
Source: https://docs.thefaithapp.com/api-reference/endpoints/events-&-volunteers/check-in-event-registration
/api-reference/openapi.json post /v1/events/{eventId}/registrations/{registrationId}/check-in
Marks an event registration as checked in.
# Export Event Registrations
Source: https://docs.thefaithapp.com/api-reference/endpoints/events-&-volunteers/export-event-registrations
/api-reference/openapi.json get /v1/events/{eventId}/registrations/export
Downloads event registrations as CSV.
# Get Events
Source: https://docs.thefaithapp.com/api-reference/endpoints/events-&-volunteers/get-events
/api-reference/openapi.json get /v1/events
Retrieve a paginated list of events for the authenticated user's church. Supports optional pagination.
# List Event Categories
Source: https://docs.thefaithapp.com/api-reference/endpoints/events-&-volunteers/list-event-categories
/api-reference/openapi.json get /v1/event-categories
Returns event categories available to the authenticated member's church.
# List Event Registrations
Source: https://docs.thefaithapp.com/api-reference/endpoints/events-&-volunteers/list-event-registrations
/api-reference/openapi.json get /v1/events/{eventId}/registrations
Returns a paginated registration list for an event in the authenticated church.
# List My Volunteer Commitments
Source: https://docs.thefaithapp.com/api-reference/endpoints/events-&-volunteers/list-my-volunteer-commitments
/api-reference/openapi.json get /v1/volunteer/my-commitments
Returns the authenticated member's volunteer signups.
# List Volunteer Categories
Source: https://docs.thefaithapp.com/api-reference/endpoints/events-&-volunteers/list-volunteer-categories
/api-reference/openapi.json get /v1/volunteer/categories
Returns volunteer categories configured for the authenticated church.
# List Volunteer Ministries
Source: https://docs.thefaithapp.com/api-reference/endpoints/events-&-volunteers/list-volunteer-ministries
/api-reference/openapi.json get /v1/volunteer/ministries
Returns volunteer ministries configured for the authenticated church.
# List Volunteer Opportunities
Source: https://docs.thefaithapp.com/api-reference/endpoints/events-&-volunteers/list-volunteer-opportunities
/api-reference/openapi.json get /v1/volunteer/opportunities
Returns active volunteer opportunities for the authenticated church.
# Register For Event
Source: https://docs.thefaithapp.com/api-reference/endpoints/events-&-volunteers/register-for-event
/api-reference/openapi.json post /v1/events/{event}/register
Creates a built-in registration for the authenticated member.
# Sign Up for Volunteer Opportunity
Source: https://docs.thefaithapp.com/api-reference/endpoints/events-&-volunteers/sign-up-for-volunteer-opportunity
/api-reference/openapi.json post /v1/volunteer/opportunities/{id}/signup
Creates a pending or approved volunteer commitment for the authenticated member.
# Complete Hosted Auth Sign-In
Source: https://docs.thefaithapp.com/api-reference/endpoints/hosted-auth/complete-hosted-auth-sign-in
/api-reference/openapi.json post /v1/auth/complete
Verifies the Firebase ID token produced by the hosted sign-in page and returns a callback URL containing a short-lived authorization code.
# Create Hosted Auth URL
Source: https://docs.thefaithapp.com/api-reference/endpoints/hosted-auth/create-hosted-auth-url
/api-reference/openapi.json post /v1/auth/start
Creates a TheFaithApp-hosted sign-in URL for the church identified by the client key. Open the returned auth_url in a browser or mobile auth session.
# Exchange Hosted Auth Code
Source: https://docs.thefaithapp.com/api-reference/endpoints/hosted-auth/exchange-hosted-auth-code
/api-reference/openapi.json post /v1/auth/token
Exchanges a one-time hosted auth code for a TheFaithApp member bearer token. Codes are short-lived, single-use, and bound to the redirect_uri used when auth started.
# Get Hosted Auth Configuration
Source: https://docs.thefaithapp.com/api-reference/endpoints/hosted-auth/get-hosted-auth-configuration
/api-reference/openapi.json get /v1/auth/config
Returns public church branding, enabled sign-in providers, and whether a redirect URL is allowed.
# Sign Out Hosted Auth Member
Source: https://docs.thefaithapp.com/api-reference/endpoints/hosted-auth/sign-out-hosted-auth-member
/api-reference/openapi.json post /v1/auth/logout
Revokes the current TheFaithApp member bearer token. Call this when the member signs out of your app.
# Connect To A Campus
Source: https://docs.thefaithapp.com/api-reference/endpoints/member-connections/connect-to-a-campus
/api-reference/openapi.json post /v1/member-connections/campuses/{branchId}
Creates or updates the authenticated member’s connection to a church campus. Church settings determine whether approval is required.
# Connect To A Ministry
Source: https://docs.thefaithapp.com/api-reference/endpoints/member-connections/connect-to-a-ministry
/api-reference/openapi.json post /v1/member-connections/ministries/{ministryId}
Creates or updates the authenticated member’s connection to a ministry. Church settings determine whether approval is required.
# Get Member Connections
Source: https://docs.thefaithapp.com/api-reference/endpoints/member-connections/get-member-connections
/api-reference/openapi.json get /v1/member-connections
Returns the authenticated member’s active and pending campus, ministry, and community-group connections plus available connection options.
# Leave A Campus
Source: https://docs.thefaithapp.com/api-reference/endpoints/member-connections/leave-a-campus
/api-reference/openapi.json delete /v1/member-connections/campuses/{branchId}
Ends the authenticated member’s connection to the selected campus.
# Leave A Ministry
Source: https://docs.thefaithapp.com/api-reference/endpoints/member-connections/leave-a-ministry
/api-reference/openapi.json delete /v1/member-connections/ministries/{ministryId}
Ends the authenticated member’s connection to the selected ministry and synchronizes linked chat access.
# Accept A Mutual-Aid Response
Source: https://docs.thefaithapp.com/api-reference/endpoints/mutual-aid/accept-a-mutual-aid-response
/api-reference/openapi.json post /v1/mutual-aid-posts/{post}/responses/{response}/accept
Accepts a pending response on a post owned by the authenticated member.
# Close A Mutual-Aid Post
Source: https://docs.thefaithapp.com/api-reference/endpoints/mutual-aid/close-a-mutual-aid-post
/api-reference/openapi.json post /v1/mutual-aid-posts/{post}/close
Closes a mutual-aid post owned by the authenticated member.
# Create A Mutual-Aid Post
Source: https://docs.thefaithapp.com/api-reference/endpoints/mutual-aid/create-a-mutual-aid-post
/api-reference/openapi.json post /v1/mutual-aid-posts
Creates a need or offer. Church configuration and category rules determine whether it is published or held for review.
# Decline A Mutual-Aid Response
Source: https://docs.thefaithapp.com/api-reference/endpoints/mutual-aid/decline-a-mutual-aid-response
/api-reference/openapi.json post /v1/mutual-aid-posts/{post}/responses/{response}/decline
Declines a pending response on a post owned by the authenticated member.
# Get A Mutual-Aid Post
Source: https://docs.thefaithapp.com/api-reference/endpoints/mutual-aid/get-a-mutual-aid-post
/api-reference/openapi.json get /v1/mutual-aid-posts/{post}
Returns a visible mutual-aid post. Owners also receive private responses and their audit history.
# Get My Mutual-Aid Activity
Source: https://docs.thefaithapp.com/api-reference/endpoints/mutual-aid/get-my-mutual-aid-activity
/api-reference/openapi.json get /v1/mutual-aid-activity
Returns mutual-aid posts created by the member and responses submitted by the member.
# List Mutual-Aid Posts
Source: https://docs.thefaithapp.com/api-reference/endpoints/mutual-aid/list-mutual-aid-posts
/api-reference/openapi.json get /v1/mutual-aid-posts
Lists mutual-aid needs and offers visible to the authenticated member, ordered by urgency and recency.
# Mark A Mutual-Aid Post Fulfilled
Source: https://docs.thefaithapp.com/api-reference/endpoints/mutual-aid/mark-a-mutual-aid-post-fulfilled
/api-reference/openapi.json post /v1/mutual-aid-posts/{post}/fulfill
Marks a mutual-aid post owned by the authenticated member as fulfilled.
# Report A Mutual-Aid Post
Source: https://docs.thefaithapp.com/api-reference/endpoints/mutual-aid/report-a-mutual-aid-post
/api-reference/openapi.json post /v1/mutual-aid-posts/{post}/report
Privately reports a mutual-aid post to church staff for safety or moderation review.
# Respond To A Mutual-Aid Post
Source: https://docs.thefaithapp.com/api-reference/endpoints/mutual-aid/respond-to-a-mutual-aid-post
/api-reference/openapi.json post /v1/mutual-aid-posts/{post}/responses
Sends a private response to a mutual-aid post and starts a private coordination flow.
# Update A Mutual-Aid Post
Source: https://docs.thefaithapp.com/api-reference/endpoints/mutual-aid/update-a-mutual-aid-post
/api-reference/openapi.json put /v1/mutual-aid-posts/{post}
Updates fields on a mutual-aid post owned by the authenticated member.
# Withdraw A Mutual-Aid Response
Source: https://docs.thefaithapp.com/api-reference/endpoints/mutual-aid/withdraw-a-mutual-aid-response
/api-reference/openapi.json post /v1/mutual-aid-posts/{post}/responses/{response}/withdraw
Withdraws the authenticated member's response from a mutual-aid post.
# Batch Track Notification Analytics
Source: https://docs.thefaithapp.com/api-reference/endpoints/notification-analytics/batch-track-notification-analytics
/api-reference/openapi.json post /v1/notification-analytics/batch-track
Records multiple notification delivery, open, or click events.
# Get Notification Analytics Summary
Source: https://docs.thefaithapp.com/api-reference/endpoints/notification-analytics/get-notification-analytics-summary
/api-reference/openapi.json get /v1/notification-analytics/summary
Returns aggregate delivery, open, and click metrics for a church.
# Track Notification Click
Source: https://docs.thefaithapp.com/api-reference/endpoints/notification-analytics/track-notification-click
/api-reference/openapi.json post /v1/notification-analytics/track/click
Records a notification click event.
# Track Notification Delivery
Source: https://docs.thefaithapp.com/api-reference/endpoints/notification-analytics/track-notification-delivery
/api-reference/openapi.json post /v1/notification-analytics/track/delivery
Records a notification delivery event.
# Track Notification Open
Source: https://docs.thefaithapp.com/api-reference/endpoints/notification-analytics/track-notification-open
/api-reference/openapi.json post /v1/notification-analytics/track/open
Records a notification open event.
# Delete User Notification
Source: https://docs.thefaithapp.com/api-reference/endpoints/notifications-&-bulletins/delete-user-notification
/api-reference/openapi.json delete /v1/notifications/{notificationId}
Deletes a member-specific notification.
# Get Bulletins
Source: https://docs.thefaithapp.com/api-reference/endpoints/notifications-&-bulletins/get-bulletins
/api-reference/openapi.json get /v1/bulletins
Retrieve a paginated list of bulletins for the authenticated user's church. Bulletins can be either native (HTML content) or PDF files.
# Get Latest Bulletin
Source: https://docs.thefaithapp.com/api-reference/endpoints/notifications-&-bulletins/get-latest-bulletin
/api-reference/openapi.json get /v1/bulletins/latest
Retrieve the most recent bulletin for the authenticated user's church. Returns the latest published bulletin with all its content and sections.
# Get Notifications
Source: https://docs.thefaithapp.com/api-reference/endpoints/notifications-&-bulletins/get-notifications
/api-reference/openapi.json get /v1/notifications
Retrieve a paginated list of notifications for the authenticated user's church. Supports optional pagination.
# Get Single Bulletin
Source: https://docs.thefaithapp.com/api-reference/endpoints/notifications-&-bulletins/get-single-bulletin
/api-reference/openapi.json get /v1/bulletins/{bulletin}
Retrieve a specific bulletin by its ID for the authenticated user's church. Returns the complete bulletin with all its content and sections.
# List User Notifications
Source: https://docs.thefaithapp.com/api-reference/endpoints/notifications-&-bulletins/list-user-notifications
/api-reference/openapi.json get /v1/notifications/user
Returns member-specific notifications such as personal alerts or direct delivery events.
# Mark All Notifications As Read
Source: https://docs.thefaithapp.com/api-reference/endpoints/notifications-&-bulletins/mark-all-notifications-as-read
/api-reference/openapi.json patch /v1/notifications/read-all
Marks every member notification as read for the authenticated member.
# Mark Notification As Read
Source: https://docs.thefaithapp.com/api-reference/endpoints/notifications-&-bulletins/mark-notification-as-read
/api-reference/openapi.json patch /v1/notifications/{notificationId}/read
Marks a member notification as read.
# Create Care Request
Source: https://docs.thefaithapp.com/api-reference/endpoints/pastoral-care/create-care-request
/api-reference/openapi.json post /v1/care-requests
Shares a confidential Pastoral Care request for the authenticated member. Counseling, benevolence, and crisis requests are restricted to pastoral staff. Urgent or crisis requests require `emergency_acknowledged: true` because this workflow is not an emergency service.
# Create Private Life Moment
Source: https://docs.thefaithapp.com/api-reference/endpoints/pastoral-care/create-private-life-moment
/api-reference/openapi.json post /v1/care-life-moments/moments
Saves a member-owned private date that may generate an assigned-caregiver reminder only when the matching consent is enabled. One-time dates must be today or later.
# Create Quiet Day
Source: https://docs.thefaithapp.com/api-reference/endpoints/pastoral-care/create-quiet-day
/api-reference/openapi.json post /v1/care-life-moments/suppressions
Creates a member-owned quiet-day window that suppresses selected celebration messages. The member may separately allow a private pastoral acknowledgment and provide restricted guidance.
# Delete Private Life Moment
Source: https://docs.thefaithapp.com/api-reference/endpoints/pastoral-care/delete-private-life-moment
/api-reference/openapi.json delete /v1/care-life-moments/moments/{careLifeMoment}
Permanently deletes a private life moment owned by the authenticated member and removes its pending reminders.
# Delete Quiet Day
Source: https://docs.thefaithapp.com/api-reference/endpoints/pastoral-care/delete-quiet-day
/api-reference/openapi.json delete /v1/care-life-moments/suppressions/{careCommunicationSuppression}
Permanently deletes a quiet-day preference owned by the authenticated member.
# Get Pastoral Care Preferences
Source: https://docs.thefaithapp.com/api-reference/endpoints/pastoral-care/get-pastoral-care-preferences
/api-reference/openapi.json get /v1/care-life-moments
Returns the authenticated member’s consent settings, private life moments, quiet-day preferences, and supported option values. The response contains only records owned by that member.
# List My Care Requests
Source: https://docs.thefaithapp.com/api-reference/endpoints/pastoral-care/list-my-care-requests
/api-reference/openapi.json get /v1/care-requests
Returns every active and past Pastoral Care request owned by the authenticated member, plus the supported form options. Responses include member-safe visits, support plans, and timeline events but never staff notes, staff tasks, internal review signals, or resolution notes.
# Update Care Request
Source: https://docs.thefaithapp.com/api-reference/endpoints/pastoral-care/update-care-request
/api-reference/openapi.json put /v1/care-requests/{careRequest}
Replaces the editable fields on an open request owned by the authenticated member. Send the complete care-request payload. Resolved, withdrawn, or retention-purged requests cannot be edited.
# Update Pastoral Care Preferences
Source: https://docs.thefaithapp.com/api-reference/endpoints/pastoral-care/update-pastoral-care-preferences
/api-reference/openapi.json put /v1/care-life-moments/preferences
Updates one or more member-controlled consent and contact settings. Reminder and Care Radar consent are disabled by default. Disabling a consent also closes related pending follow-up signals.
# Update Private Life Moment
Source: https://docs.thefaithapp.com/api-reference/endpoints/pastoral-care/update-private-life-moment
/api-reference/openapi.json put /v1/care-life-moments/moments/{careLifeMoment}
Updates one or more fields on a private life moment owned by the authenticated member. Set `status` to `paused` to stop pending follow-up without deleting the date.
# Update Quiet Day
Source: https://docs.thefaithapp.com/api-reference/endpoints/pastoral-care/update-quiet-day
/api-reference/openapi.json put /v1/care-life-moments/suppressions/{careCommunicationSuppression}
Updates one or more fields on a quiet-day preference owned by the authenticated member. Set `active` to `false` to keep the record without suppressing messages.
# Withdraw Care Request
Source: https://docs.thefaithapp.com/api-reference/endpoints/pastoral-care/withdraw-care-request
/api-reference/openapi.json post /v1/care-requests/{careRequest}/withdraw
Withdraws an open request owned by the authenticated member. Withdrawal is final and schedules confidential case content for retention-based removal.
# Submit Prayer Request
Source: https://docs.thefaithapp.com/api-reference/endpoints/prayer/submit-prayer-request
/api-reference/openapi.json post /v1/prayer-requests
Creates a prayer request for the authenticated member and church.
# Get Resource Activity
Source: https://docs.thefaithapp.com/api-reference/endpoints/resource-sharing/get-resource-activity
/api-reference/openapi.json get /v1/community/resource-activity
Returns items offered by the member and loans requested by the member.
# List Shared Resources
Source: https://docs.thefaithapp.com/api-reference/endpoints/resource-sharing/list-shared-resources
/api-reference/openapi.json get /v1/community/resources
Lists reviewed shared resources visible to the authenticated member.
# Offer A Shared Resource
Source: https://docs.thefaithapp.com/api-reference/endpoints/resource-sharing/offer-a-shared-resource
/api-reference/openapi.json post /v1/community/resources
Submits a member-owned lending item for staff review before it becomes visible.
# Request A Resource Loan
Source: https://docs.thefaithapp.com/api-reference/endpoints/resource-sharing/request-a-resource-loan
/api-reference/openapi.json post /v1/community/resources/{resource}/loans
Requests to borrow an available shared resource. Repeated active requests are idempotent.
# Transition A Resource Loan
Source: https://docs.thefaithapp.com/api-reference/endpoints/resource-sharing/transition-a-resource-loan
/api-reference/openapi.json post /v1/community/resource-loans/{loan}/transition
Approves, declines, checks out, returns, or cancels a resource loan when the member has permission for that transition.
# Flutter Giving SDK
Source: https://docs.thefaithapp.com/api-reference/flutter-giving-sdk
Add authenticated general and campaign giving with Stripe, PayPal, and Flutterwave to a Flutter app.
# Add giving to a Flutter app
The `thefaithapp_giving` package renders general and campaign giving inside
your Flutter app. It uses the member session from `thefaithapp_auth`, presents
the church's active payment provider, and waits for TheFaithApp to confirm the
payment.
The package includes:
* general giving with funds, currency, frequency, memo, and fee coverage
* campaign giving with configured donor form fields
* Stripe PaymentSheet
* hosted PayPal and Flutterwave checkout
* checkout cancellation and expiry handling
* an extension point for future payment providers
TheFaithApp creates and verifies each checkout and processes provider webhooks.
Do not add payment-provider secret keys or webhook secrets to your mobile app.
## Before you begin
You need:
* a Flutter app targeting Android or iOS
* `thefaithapp_auth` configured with a client API key
* a signed-in TheFaithApp member
* an active payment provider configured for the church
Follow the [Flutter SDK Quickstart](/api-reference/flutter-sdk) first if member
sign-in is not working yet.
Add the auth and giving packages to `pubspec.yaml`:
```yaml theme={null}
dependencies:
thefaithapp_auth: ^0.1.0
thefaithapp_giving: ^0.1.0
```
Install them:
```bash theme={null}
flutter pub get
```
The giving package includes `flutter_stripe` and `webview_flutter`. Stop
and rebuild the app after adding it so Flutter can register their native
platform code.
Keep the platform requirements from the auth SDK:
* Android `minSdk` 24 or newer
* iOS 13.0 or newer
* Keychain Sharing enabled for the iOS Runner target
Complete any additional native configuration required by
`flutter_stripe` for the platforms and wallet features your app enables.
PayPal and Flutterwave use an in-app WebView and do not require provider
credentials in the application.
Reuse the same auth instance that signs the member in:
```dart theme={null}
import 'package:thefaithapp_auth/thefaithapp_auth.dart';
import 'package:thefaithapp_giving/thefaithapp_giving.dart';
const clientKey = String.fromEnvironment('TFA_CLIENT_KEY');
final auth = TheFaithAppAuth(apiKey: clientKey);
final giving = TheFaithAppGiving(auth: auth);
```
Before showing protected giving:
```dart theme={null}
final session = await auth.currentSession() ?? await auth.signIn();
print('Giving as ${session.member.name}');
```
The giving client does not accept a member ID or church/client ID. The
authenticated session supplies that identity on every request.
Add the built-in general giving view to a page:
```dart theme={null}
GivingView.general(
giving: giving,
onCompleted: (result) {
switch (result.state) {
case GivingPaymentState.succeeded:
// Show a thank-you state.
break;
case GivingPaymentState.pending:
// Tell the member that confirmation is still processing.
break;
case GivingPaymentState.failed:
case GivingPaymentState.cancelled:
// Keep the member on a safe retry or dismissal path.
break;
}
},
)
```
The view loads the church's giving settings and funds. It shows only the
currencies, recurrence options, memo, and fee coverage allowed by that
configuration.
Your app chooses the campaign, then passes its numeric ID to the view:
```dart theme={null}
GivingView.campaign(
giving: giving,
campaignId: 42,
onCompleted: (result) {
// Handle succeeded, pending, failed, or cancelled.
},
)
```
If the campaign has donor fields, the package renders and validates its
text, multiline text, number, email, telephone, select, radio, checkbox,
and date fields.
Campaign discovery and selection belong to your app. The package begins
with the campaign ID you provide.
## Payment-provider behavior
The package uses the church's active/default provider. An app does not choose
between Stripe, PayPal, and Flutterwave for an individual gift.
| Provider | Experience |
| ----------- | ------------------------------------ |
| Stripe | Native PaymentSheet |
| PayPal | Hosted approval in an in-app WebView |
| Flutterwave | Hosted checkout in an in-app WebView |
The result from a native sheet or WebView is not treated as proof of payment.
The SDK checks TheFaithApp's webhook-backed status before reporting the final
state. A `pending` result means the provider or webhook is still processing.
## Campaign fields
The built-in campaign view loads the campaign definition and submits its form
responses with the authenticated checkout. Required fields are validated
before the payment experience opens.
If you build a headless campaign form, send the same values with
`CampaignGivingRequest.formFields`. Do not collect or send fields that are not
part of the campaign definition.
## Recurring gifts
When recurring giving is enabled for the church and supported by its active
provider, the general and campaign views can create a recurring gift.
You can load and cancel the signed-in member's subscriptions:
```dart theme={null}
final subscriptions = await giving.getSubscriptions();
if (subscriptions.isNotEmpty) {
await giving.cancelSubscription(subscriptions.first);
}
```
The platform scopes each subscription to its general or campaign target and
rechecks the member and church before cancellation.
## Add another payment provider
Register a `GivingPaymentHandler` whose `provider` matches the value configured
on TheFaithApp:
```dart theme={null}
final giving = TheFaithAppGiving(
auth: auth,
paymentHandlers: [MyPaymentHandler()],
);
```
A handler receives only one checkout's ephemeral session and narrow
capabilities for status, PayPal capture, or Flutterwave verification. It does
not receive the auth client, client API key, bearer token, member ID, or church
ID.
Never persist or log `GivingCheckoutSession` provider data. A custom handler
must return the same donation ID and provider it received.
## Cancellation and cleanup
Closing a payment experience triggers a best-effort checkout abandonment
request. If the device is offline or the app terminates before that request
arrives, TheFaithApp expires the checkout on the server. A late valid webhook
still has a short grace period so a completed payment is not incorrectly
cancelled.
## Dispose the clients
Dispose both package instances when their owning application service is
released:
```dart theme={null}
giving.dispose();
auth.dispose();
```
## Troubleshooting
| Problem | What to check |
| ------------------------------------ | ---------------------------------------------------------------------------------------------------- |
| Giving says it is unavailable | Confirm the church has an active/default payment provider and supported giving configuration. |
| The member is not authenticated | Restore or create the auth session before rendering the giving view. |
| Stripe does not open | Perform a full native rebuild and complete the `flutter_stripe` platform setup. |
| A campaign cannot be loaded | Confirm the campaign ID belongs to the signed-in member's church and the campaign is available. |
| A required campaign field is missing | Render the campaign returned by the package instead of maintaining a separate field definition. |
| A payment remains pending | Keep the status message visible; TheFaithApp updates the donation when the provider webhook arrives. |
## Package resources
* [Package on pub.dev](https://pub.dev/packages/thefaithapp_giving)
* [Source and standalone example](https://github.com/thefaithapp/thefaithapp-giving-flutter)
# Flutter SDK Quickstart
Source: https://docs.thefaithapp.com/api-reference/flutter-sdk
Add hosted member sign-in and authenticated v1 API requests to an Android or iOS Flutter app.
# Use the API from Flutter
The `thefaithapp_auth` package signs a member in through TheFaithApp and gives
your Flutter app an authenticated client for `v1` API requests. Your app does
not need to host a callback website.
## Before you begin
You need:
* a Flutter app targeting Android or iOS
* its Android application ID or iOS bundle ID
* a client API key from `Settings > Developer Access`
Add the package to your `pubspec.yaml`:
```yaml theme={null}
dependencies:
thefaithapp_auth: ^0.1.0
```
Install it:
```bash theme={null}
flutter pub get
```
Stop and rebuild the app after adding the package so Flutter can register
its platform code.
In the TheFaithApp dashboard:
1. Open `Settings > Developer Access`.
2. Click **Add Flutter app**.
3. Append `.thefaithapp` to your application ID.
4. Add the app and copy your client API key.
For an application ID of `com.example.app`, enter:
```text theme={null}
com.example.app.thefaithapp
```
The dashboard creates the callback expected by the package:
```text theme={null}
com.example.app.thefaithapp://auth/callback
```
Use a lowercase reverse-domain application ID containing letters, numbers,
and dots. Avoid underscores because they cannot be used in a callback URI
scheme.
**Android**
* Set `minSdk` to `24` or newer.
* No manual callback activity is required.
**iOS**
* Set the deployment target to iOS `13.0` or newer.
* Enable **Keychain Sharing** for the Runner target in Xcode.
No callback URL type needs to be added manually when using the package's
default system authentication session.
Provide the client key when creating `TheFaithAppAuth`:
```dart theme={null}
import 'package:thefaithapp_auth/thefaithapp_auth.dart';
const clientKey = String.fromEnvironment('TFA_CLIENT_KEY');
final auth = TheFaithAppAuth(apiKey: clientKey);
```
Pass the value from your build environment instead of committing it to the
repository:
```bash theme={null}
flutter run \
--dart-define=TFA_CLIENT_KEY=replace-with-your-client-key
```
Open hosted sign-in from a button or another user action:
```dart theme={null}
Future signInMember() async {
return auth.signIn();
}
```
After the member finishes signing in, the package returns to the app and
saves the session securely.
Use the authorized client for protected API requests:
```dart theme={null}
import 'dart:convert';
Future> loadCurrentMember() async {
final client = auth.authorizedClient();
try {
final response = await client.get(auth.apiUri('/v1/user'));
final body = jsonDecode(response.body) as Map;
if (response.statusCode < 200 || response.statusCode >= 300) {
throw Exception(body['message'] ?? 'The request failed.');
}
return Map.from(body['data'] as Map);
} finally {
client.close();
}
}
```
Use `auth.apiUri('/v1/...')` for other endpoints in the API Reference.
## Restore the saved session
Check for a saved session when the app starts:
```dart theme={null}
final session = await auth.currentSession();
if (session != null) {
print('Welcome back, ${session.member.name}');
}
```
If `currentSession()` returns `null`, show the sign-in action again.
## Sign out
Revoke the member session and remove its saved copy:
```dart theme={null}
await auth.signOut();
```
Release the SDK's resources when the owning service or widget is disposed:
```dart theme={null}
auth.dispose();
```
## Handle SDK errors
Catch `TheFaithAuthException` to show an appropriate message:
```dart theme={null}
try {
await auth.signIn();
} on TheFaithAuthException catch (error) {
switch (error.code) {
case TheFaithAuthErrorCode.cancelled:
// The member closed the sign-in session.
break;
default:
// Show error.message or your own friendly message.
break;
}
}
```
## Troubleshooting
| Problem | What to check |
| -------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| The redirect is rejected | Confirm the value added with **Add Flutter app** matches the application's ID with `.thefaithapp` appended. |
| The app does not reopen after sign-in | Stop and rebuild the app, then confirm the installed app uses the expected application ID. |
| `MissingPluginException` appears | Stop the running app and perform a full rebuild after adding the package. |
| A protected request says the member is not authenticated | Call `signIn()` or restore a saved session before creating the request. |
| The session is not restored on iOS | Confirm **Keychain Sharing** is enabled for the Runner target. |
## Next steps
* Add authenticated general and campaign giving with the
[Flutter Giving SDK](/api-reference/flutter-giving-sdk).
* Browse the endpoint groups in the API Reference navigation.
* Read [Pagination and Errors](/api-reference/pagination-and-errors) before
loading lists or adding retry behavior.
* Use the public
[standalone sample](https://github.com/thefaithapp/thefaithapp-auth-flutter/tree/main/example)
as a compact reference implementation.
# Hosted Auth Guide
Source: https://docs.thefaithapp.com/api-reference/hosted-auth
Sign members into your app with TheFaithApp-hosted auth, then use member tokens for API calls.
# Hosted Auth Guide
Hosted auth lets your app sign members in without managing auth provider credentials or building your own member login screen. Your app sends the member to a TheFaithApp-hosted page, receives a one-time code on your callback URL, exchanges that code for a member token, and then uses that token for normal API calls.
## When To Use It
Use hosted auth for external web or mobile apps that need to read or update church-scoped member data through the `v1` API.
The member signs in once. After that, store the returned TheFaithApp member token securely and use it for future API calls.
## What You Need
* A client key from `Settings > Developer Access`
* One or more saved Redirect URLs
* A backend or mobile client that can exchange the returned code for a token
* A place to store the returned member token securely
## Supported Sign-In Methods
The hosted sign-in page supports:
* Google
* Apple
* Email/password sign in
* Email/password account creation with display name
New members are created automatically under the church identified by the client key. Existing members are updated from the verified sign-in profile when they sign in.
## Redirect URLs
Add every callback that can receive auth codes in `Settings > Developer Access`.
For Flutter, select **Add Flutter app** and enter your app's application ID with
`.thefaithapp` appended. For example, enter
`com.example.app.thefaithapp` for an app whose application ID is
`com.example.app`. TheFaithApp registers
`com.example.app.thefaithapp://auth/callback` automatically.
For React Native and Expo, select **Add React Native app**. Enter the same
application ID with `.thefaithapp` appended; the React Native SDK config plugin
registers the resulting callback in the native iOS and Android projects.
Examples:
```text theme={null}
https://example.com/auth/callback
https://staging.example.com/auth/callback
mychurch://auth/callback
com.example.mychurch://auth/callback
```
The `redirect_uri` you send to the API must exactly match one saved Redirect URL. If you use a mobile app, register the same deep link or app link scheme in your mobile project.
Hosted auth always runs on the TheFaithApp auth host. Church custom domains do not host the auth page.
## Full Flow
1. Generate a random `state` value in your app.
2. Call `POST /v1/auth/start` with your `client_key`, `redirect_uri`, and `state`.
3. Open the returned `auth_url` in a browser tab, mobile browser, or mobile auth session.
4. The member signs in or creates an account.
5. TheFaithApp redirects to your `redirect_uri` with `code` and `state`.
6. Confirm the returned `state` matches the one you generated.
7. Call `POST /v1/auth/token` with the one-time `code`.
8. Store the returned `access_token`.
9. Call protected `v1` endpoints with both `X-API-Key` and `Authorization`.
```mermaid theme={null}
sequenceDiagram
participant App as Your app
participant API as TheFaithApp API
participant Auth as Hosted auth page
participant User as Member
App->>API: POST /v1/auth/start
API-->>App: auth_url
App->>Auth: Open auth_url
User->>Auth: Sign in or create account
Auth->>API: Complete hosted auth
API-->>Auth: redirect_to with code
Auth-->>App: redirect_uri?code=...&state=...
App->>API: POST /v1/auth/token
API-->>App: access_token + member
App->>API: GET /v1/audios with API key + bearer token
```
## 1. Start Sign-In
```bash theme={null}
curl -X POST https://api.thefaithapp.com/v1/auth/start \
-H "Content-Type: application/json" \
-d '{
"client_key": "your-client-api-key",
"redirect_uri": "https://example.com/auth/callback",
"state": "replace-with-random-state"
}'
```
Example response:
```json theme={null}
{
"auth_url": "https://auth.thefaithapp.com/member/sign-in?client_key=your-client-api-key&redirect_uri=https%3A%2F%2Fexample.com%2Fauth%2Fcallback&state=replace-with-random-state",
"client": {
"id": 45,
"name": "Example Church",
"image": "clients/example-logo.png",
"image_url": "https://cdn.example.com/clients/example-logo.png",
"about": null,
"public_uuid": "11111111-2222-3333-4444-555555555555"
},
"redirect_uri": "https://example.com/auth/callback",
"providers": ["google", "apple", "email"]
}
```
Open `auth_url` for the member. Do not iframe the hosted auth page.
## 2. Receive The Code
After sign-in, TheFaithApp redirects back to your callback:
```text theme={null}
https://example.com/auth/callback?code=one-time-code&state=replace-with-random-state
```
Your app should:
* read `code`
* read `state`
* reject the callback if `state` does not match the value you generated
* exchange `code` immediately
Authorization codes are short-lived and can only be used once.
## 3. Exchange The Code
```bash theme={null}
curl -X POST https://api.thefaithapp.com/v1/auth/token \
-H "Content-Type: application/json" \
-d '{
"client_key": "your-client-api-key",
"code": "one-time-code",
"redirect_uri": "https://example.com/auth/callback"
}'
```
Example response:
```json theme={null}
{
"access_token": "member-bearer-token",
"token_type": "Bearer",
"member": {
"id": 123,
"name": "Jane Member",
"email": "jane@example.com",
"client_id": 45,
"uuid": "member-user-id"
}
}
```
Store `access_token` securely. For mobile apps, use secure device storage such as Keychain or Keystore. For server-rendered web apps, keep the token server-side or in an HTTP-only secure session cookie.
## 4. Call The API
Every protected `v1` request needs both headers:
```http theme={null}
X-API-Key: your-client-api-key
Authorization: Bearer member-bearer-token
```
Example:
```bash theme={null}
curl https://api.thefaithapp.com/v1/audios?per_page=3 \
-H "X-API-Key: your-client-api-key" \
-H "Authorization: Bearer member-bearer-token" \
-H "Accept: application/json"
```
## Mobile Apps
For mobile apps, use the platform's browser-based auth session:
* iOS: `ASWebAuthenticationSession`
* Android: Chrome Custom Tabs or the AppAuth browser flow
* React Native or Flutter: use a browser auth/session package that supports callback URLs
Use a redirect URL your app can receive, such as an app link, universal link, or custom scheme. The exact value must be saved in Developer Access before it can be used.
For the TheFaithApp mobile SDKs, use **Add Flutter app** or **Add React Native
app** in Developer Access so you only enter the package name. The dashboard
creates the exact callback URL expected by the SDK.
Flutter:
```dart theme={null}
final auth = TheFaithAppAuth(apiKey: 'your-client-api-key');
```
For the full package setup and API request example, follow the
[Flutter SDK Quickstart](/api-reference/flutter-sdk).
React Native and Expo:
```tsx theme={null}
const auth = new TheFaithAppAuth({ apiKey: 'your-client-api-key' })
```
Follow the [React Native SDK Quickstart](/api-reference/react-native-sdk) for
the config plugin, native build, and API request example.
A mobile callback is handled by the installed app. Mobile developers do not need to host a separate website just to receive the authorization code.
## Optional PKCE
Public clients can include PKCE values when starting auth:
```json theme={null}
{
"client_key": "your-client-api-key",
"redirect_uri": "mychurch://auth/callback",
"state": "replace-with-random-state",
"code_challenge": "base64url-sha256-code-verifier",
"code_challenge_method": "S256"
}
```
Then include the matching `code_verifier` during token exchange:
```json theme={null}
{
"client_key": "your-client-api-key",
"code": "one-time-code",
"redirect_uri": "mychurch://auth/callback",
"code_verifier": "original-random-code-verifier"
}
```
PKCE is recommended for mobile and other public clients.
## Logout
To invalidate a member token, call `POST /v1/auth/logout` with the same API key and bearer token:
```bash theme={null}
curl -X POST https://api.thefaithapp.com/v1/auth/logout \
-H "X-API-Key: your-client-api-key" \
-H "Authorization: Bearer member-bearer-token" \
-H "Accept: application/json"
```
## Common Errors
| Status | When it happens | How to fix it |
| ------ | ------------------------------------------------------------------------------- | ----------------------------------------------------------------- |
| `403` | The `redirect_uri` is not saved for this client key. | Add the exact redirect URL in Developer Access. |
| `404` | The `client_key` is unknown. | Confirm you copied the client key from the correct church. |
| `422` | A required request field is missing or invalid. | Check `client_key`, `redirect_uri`, `code`, and PKCE fields. |
| `400` | The code is invalid, expired, already used, or the redirect URL does not match. | Start a fresh hosted auth flow and exchange the new code quickly. |
| `401` | A protected API request has a missing or invalid bearer token. | Exchange the hosted auth code and use the returned member token. |
## Endpoint Reference
Open the `Hosted Auth` section in the API Reference navigation for the live
request builder, complete schemas, and generated examples for each auth route.
# API Introduction
Source: https://docs.thefaithapp.com/api-reference/introduction
Integrate member sign-in, church content, engagement, giving, events, and analytics through the stable v1 partner API.
# TheFaithApp Partner API
TheFaithApp `v1` is the supported API for third-party web and mobile apps. It lets an integration sign in members through hosted auth and work with the member's church-scoped content and workflows.
## Base URL
```text theme={null}
https://api.thefaithapp.com
```
All request and response bodies use JSON unless an endpoint explicitly documents a file response, such as a CSV export.
## Authentication at a glance
Protected requests require two credentials:
```http theme={null}
X-API-Key: your-client-api-key
Authorization: Bearer your-member-access-token
```
* The client API key identifies the partner app and church.
* The bearer token identifies the signed-in member.
* The member token must belong to the same church as the client API key.
The hosted-auth setup and code-exchange endpoints do not use these headers. They accept the client key in the request so a member can sign in before an access token exists.
Complete hosted sign-in and load the current member.
Learn redirects, state validation, PKCE, token storage, and logout.
Add member sign-in and authenticated API requests to an Android or iOS app.
Add hosted sign-in to an Expo or React Native app.
Render authenticated general and campaign giving in a Flutter app.
Render authenticated general and campaign giving in React Native or Expo.
## What you can build
* Personalized church home experiences
* Audio and video sermon libraries, transcripts, chapters, and insights
* Devotionals, live streams, favorites, and bookmarks
* Church discovery and public church profiles
* Event registration and volunteer workflows
* Member campus and ministry connections, community groups, and group resources
* Shared-resource lending and mutual-aid needs and offers
* Member notifications and bulletins
* Hosted church giving experiences
* Prayer request submission
* Confidential, member-owned Pastoral Care requests and follow-up preferences
* Product and notification analytics
Chat and messaging routes are not part of this partner reference.
## Context headers
Some content changes with the member's local date or timezone:
| Header | Use |
| ------------------- | --------------------------------------------------------------------------------- |
| `X-Client-Date` | Resolve date-sensitive content such as devotionals. Use `YYYY-MM-DD`. |
| `X-Client-Timezone` | Resolve time-sensitive home content in an IANA timezone such as `Africa/Kampala`. |
## Request safety
Use an idempotency strategy in your own application for user actions. A network retry can otherwise submit the same logical action more than once when an endpoint does not expose an idempotency key.
Keep API keys and member tokens out of browser logs, analytics payloads, crash reports, source control, and public screenshots.
## Versioning
The version is part of every endpoint path. Backward-compatible fields may be added to `v1` responses over time, so clients should ignore fields they do not recognize. A breaking contract change requires a new API version.
# Pagination and Errors
Source: https://docs.thefaithapp.com/api-reference/pagination-and-errors
Handle paginated collections, validation failures, authorization errors, and safe retries.
# Response conventions
The API uses a small number of response shapes. Always branch on the HTTP status code first, then inspect the JSON body for endpoint-specific details.
## Status envelopes
Many member-scoped endpoints return:
```json theme={null}
{
"status": "Success",
"data": {}
}
```
Some endpoints use a boolean success field:
```json theme={null}
{
"success": true,
"data": {}
}
```
Treat both shapes as endpoint contracts; do not assume every endpoint uses the same top-level field names.
## Pagination
Collection endpoints generally accept `page` and `per_page`. `per_page` is capped by the endpoint, commonly at 100.
Laravel-style collection responses include the records in `data` plus pagination metadata:
```json theme={null}
{
"current_page": 1,
"data": [],
"last_page": 1,
"per_page": 20,
"total": 0,
"next_page_url": null,
"prev_page_url": null
}
```
Some endpoints wrap that paginator inside a success envelope:
```json theme={null}
{
"status": "Success",
"data": {
"current_page": 1,
"data": [],
"per_page": 20,
"total": 0
}
}
```
Follow the schema on each endpoint page and stop when `next_page_url` is `null` or `current_page` equals `last_page`.
## Error bodies
Depending on the endpoint, the human-readable message can appear in `message`, `error`, or `error_message`:
```json theme={null}
{
"status": "Error",
"message": "Validation failed",
"errors": {
"amount": ["The amount field is required."]
}
}
```
Use the field-specific `errors` object to guide form corrections. Do not show raw server error details to end users.
## Common status codes
| Status | Meaning | Recommended handling |
| ------ | -------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
| `400` | The request conflicts with the resource's current state. | Correct the action or refresh the resource before retrying. |
| `401` | API key or bearer token is missing, invalid, expired, or mismatched. | Re-authenticate the member and verify both credentials belong to the same church. |
| `403` | The member is authenticated but lacks permission. | Do not retry without a permission or resource-context change. |
| `404` | The resource does not exist in the authenticated church. | Refresh local state and stop retrying the same identifier. |
| `422` | One or more inputs failed validation. | Display safe field-level validation messages. |
| `429` | The rate limit was exceeded. | Back off and retry after the server's retry window. |
| `500` | An unexpected server error occurred. | Retry read-only requests with bounded exponential backoff; avoid automatically repeating mutations. |
## Retry guidance
* Retry `429` and transient `5xx` responses with exponential backoff and jitter.
* Cap retry attempts and set request timeouts.
* Retry safe reads automatically only when your product can tolerate stale or delayed data.
* Do not automatically retry registration, signup, or other mutations unless your application can prove the first request did not succeed.
* Log a request correlation identifier if one is returned, but never log API keys, member tokens, or personal response bodies.
# Pastoral Care Integration
Source: https://docs.thefaithapp.com/api-reference/pastoral-care
Build a confidential, member-owned Pastoral Care experience with the public v1 API.
## Build Pastoral Care into your app
The Pastoral Care API gives a signed-in member the same confidential workflows
available in TheFaithApp mobile app:
* Share, review, edit, and withdraw a care request.
* See member-safe status, visit, support-plan, and timeline information.
* Manage consent for private follow-up.
* Save or pause a private life-moment date.
* Create a quiet-day window for sensitive seasons.
Pastoral Care carries sensitive personal information. Never send request
details, private dates, contact values, quiet-day reasons, or member guidance
to analytics, crash reporting, application logs, push-notification payloads,
or AI services.
## Authentication
Every Pastoral Care call requires the partner app key and the signed-in
member's access token:
```http theme={null}
X-API-Key: your-client-api-key
Authorization: Bearer your-member-access-token
Accept: application/json
Content-Type: application/json
```
The app key and member token must resolve to the same church. A mismatch returns
`401 Unauthorized`.
Follow the [Hosted Auth guide](/api-reference/hosted-auth) before integrating
these endpoints.
## Published endpoints
The public contract mirrors the Pastoral Care calls used by TheFaithApp mobile
app.
| Member action | Endpoint |
| ----------------------------------------------- | -------------------------------------------------------------------------- |
| Load requests and form options | `GET /v1/care-requests` |
| Share a request | `POST /v1/care-requests` |
| Edit an open request | `PUT /v1/care-requests/{careRequest}` |
| Withdraw an open request | `POST /v1/care-requests/{careRequest}/withdraw` |
| Load preferences, private dates, and quiet days | `GET /v1/care-life-moments` |
| Update consent and contact preferences | `PUT /v1/care-life-moments/preferences` |
| Add a private date | `POST /v1/care-life-moments/moments` |
| Update or pause a private date | `PUT /v1/care-life-moments/moments/{careLifeMoment}` |
| Permanently remove a private date | `DELETE /v1/care-life-moments/moments/{careLifeMoment}` |
| Add a quiet day | `POST /v1/care-life-moments/suppressions` |
| Update or deactivate a quiet day | `PUT /v1/care-life-moments/suppressions/{careCommunicationSuppression}` |
| Permanently remove a quiet day | `DELETE /v1/care-life-moments/suppressions/{careCommunicationSuppression}` |
Staff notes, staff tasks, resolution notes, Care Radar review signals, coverage
rotations, availability, rite runsheets, preaching plans, and staff
coordination are not public partner endpoints.
## Recommended app flow
Call `GET /v1/care-requests`. Keep the returned `options` with the screen;
they are the allowed values for care type, privacy, urgency, and contact
method.
The list contains active and past requests. Use `can_edit` and
`can_withdraw` to decide which actions to display.
Explain `care_team` and `pastoral_only` before submission. Counseling,
benevolence, and crisis requests are always restricted to pastoral staff, even
if the app sends `care_team`.
Send `contact_consent: true` only after the member actively confirms that
the church care team may contact them.
For phone, text, or email contact, `contact_value` may be omitted when the
signed-in member profile already has the matching value.
For `urgency: "urgent"` or `type: "crisis_support"`, show a clear notice that
Pastoral Care is not an emergency service. Submit `emergency_acknowledged:
true` only after the member confirms the notice.
Use the care request returned by create, update, or withdraw immediately,
then refresh `GET /v1/care-requests` when the screen resumes or receives a
generic care-status notification.
## Share a care request
```bash theme={null}
curl -X POST https://api.thefaithapp.com/v1/care-requests \
-H "X-API-Key: your-client-api-key" \
-H "Authorization: Bearer your-member-access-token" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{
"type": "hospital_visit",
"privacy": "care_team",
"urgency": "soon",
"details": "Please arrange a hospital visit later this week.",
"contact_preference": "phone",
"contact_consent": true
}'
```
A successful create returns `201 Created` and the new record in
`data.care_request`.
### Care types
Use the values returned in `data.options.types`. The current values are:
| Value | Member-facing meaning |
| ------------------------- | ----------------------- |
| `general_care` | General care |
| `hospital_visit` | Hospital visit |
| `home_visit` | Home visit |
| `new_baby_support` | New-baby support |
| `counseling` | Counseling |
| `benevolence` | Benevolence |
| `grief_support` | Grief support |
| `illness_support` | Illness support |
| `crisis_support` | Crisis support |
| `pastoral_follow_up` | Pastoral follow-up |
| `wedding_preparation` | Wedding preparation |
| `baby_dedication` | Baby dedication |
| `funeral_support` | Funeral support |
| `relocation_support` | Relocation support |
| `pastoral_recommendation` | Pastoral recommendation |
## Render a request safely
Each care request can include:
* `status`, `urgency`, and whether a caregiver is assigned.
* `next_follow_up_at` when the care team has scheduled a follow-up.
* Member-visible visit times, location, instructions, and outcome.
* Member-visible support-plan dates, coordinator, and requested support.
* A reduced timeline of safe workflow events.
* `content_purged` when confidential content has reached the end of retention.
The response intentionally omits staff notes, staff tasks, internal review
activity, coverage handoffs, and private resolution summaries.
There is no public single-request `GET` endpoint. Keep the selected item from
`GET /v1/care-requests`, and refresh the list when current data is needed.
## Edit and withdraw
`PUT /v1/care-requests/{careRequest}` is a full form update. Send all required
request fields, not only the changed field.
Use `POST /v1/care-requests/{careRequest}/withdraw` only after a confirmation
step. Withdrawal is final. The response sets `can_edit` and `can_withdraw` to
`false`.
Resolved, withdrawn, and retention-purged requests cannot be edited.
## Member-controlled follow-up
Call `GET /v1/care-life-moments` to load:
* `preferences`: current consent and contact choices.
* `life_moments`: private dates owned by the member.
* `suppressions`: the member's quiet-day windows.
* `options`: the supported enum values for your controls.
All reminder and Care Radar consent starts disabled.
### Update preferences
Preference updates are partial. Send only the settings the member changed:
```bash theme={null}
curl -X PUT https://api.thefaithapp.com/v1/care-life-moments/preferences \
-H "X-API-Key: your-client-api-key" \
-H "Authorization: Bearer your-member-access-token" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{
"reminders_enabled": true,
"grief_follow_up_enabled": true,
"hard_anniversary_follow_up_enabled": true,
"contact_preference": "text",
"acknowledgment_style": "ask_first"
}'
```
Enabling a specific kind does not bypass the master `reminders_enabled`
setting. Care Radar participation and Community Group participation follow-up
also require their own separate member choices.
### Save a private life moment
```bash theme={null}
curl -X POST https://api.thefaithapp.com/v1/care-life-moments/moments \
-H "X-API-Key: your-client-api-key" \
-H "Authorization: Bearer your-member-access-token" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{
"kind": "grief_anniversary",
"status": "active",
"title": "Remember Mum",
"event_date": "2026-09-14",
"recurrence": "yearly",
"reminder_lead_days": 7,
"member_note": "Please ask before calling."
}'
```
One-time dates must be today or later. Yearly dates can retain an earlier
calendar year because the next reminder is calculated from the next
anniversary.
Set `status: "paused"` to keep the private date without creating pending
follow-up. `DELETE` permanently removes the date and its pending reminders.
### Create a quiet day
```bash theme={null}
curl -X POST https://api.thefaithapp.com/v1/care-life-moments/suppressions \
-H "X-API-Key: your-client-api-key" \
-H "Authorization: Bearer your-member-access-token" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{
"topic": "all_celebrations",
"starts_on": "2026-09-01",
"ends_on": "2026-09-30",
"pastoral_acknowledgment": true,
"reason": "A sensitive family season.",
"member_guidance": "A private text from a pastor is welcome."
}'
```
New quiet days are active by default. The end date must be on or after the
start date. Setting `active: false` keeps the preference for later reuse;
deleting it removes the record permanently.
## Error handling
| Status | Meaning for Pastoral Care |
| ------ | ------------------------------------------------------------------------------------------------- |
| `401` | API key or member token is missing, invalid, expired, or belongs to another church. |
| `404` | The resource does not exist or is not owned by the signed-in member. |
| `422` | Required values, consent, date rules, enum values, or emergency acknowledgment failed validation. |
| `429` | The partner API rate limit was reached. Honor `Retry-After` and retry with backoff. |
Treat `404` as a final resource miss. Do not reveal whether the identifier
belongs to another member or church.
Display validation messages beside their matching fields, but keep raw request
payloads out of logs and support diagnostics.
## Integration checklist
* Use hosted member sign-in and keep both credentials in secure storage.
* Build controls from the returned option arrays instead of hard-coding them.
* Require explicit contact consent.
* Show the non-emergency notice for urgent and crisis requests.
* Use `can_edit` and `can_withdraw` from the API response.
* Do not add Pastoral Care payloads to offline caches or analytics.
* Clear sensitive view state when the member signs out or changes church.
* Use generic push-notification copy and fetch current data after the member
opens the app.
* Test with two members and two churches to verify ownership boundaries.
Review the complete response contract and try the request.
See private dates, quiet days, and supported option values.
# Quickstart
Source: https://docs.thefaithapp.com/api-reference/quickstart
Sign in a member and make your first authenticated TheFaithApp API request.
# Make your first request
This quickstart uses hosted auth to obtain a member token, then calls `GET /v1/user` with both required credentials.
## Before you begin
In `Settings > Developer Access` in the TheFaithApp dashboard:
1. Copy your client API key.
2. Add the exact callback URL that will receive the member after sign-in.
For local development, save a dedicated callback such as `http://localhost:3000/auth/callback`. Production and local callback URLs must each be added explicitly.
Generate a cryptographically random `state` value and send it with your callback URL.
```bash theme={null}
curl -X POST https://api.thefaithapp.com/v1/auth/start \
-H "Content-Type: application/json" \
-d '{
"client_key": "your-client-api-key",
"redirect_uri": "https://example.com/auth/callback",
"state": "replace-with-a-random-value"
}'
```
The response includes `auth_url`. Open it in the system browser or a browser-based mobile auth session.
After sign-in, the member returns to your callback URL:
```text theme={null}
https://example.com/auth/callback?code=one-time-code&state=replace-with-a-random-value
```
Reject the callback if `state` does not exactly match the value stored when sign-in began. Exchange `code` immediately; it is short-lived and single-use.
```bash theme={null}
curl -X POST https://api.thefaithapp.com/v1/auth/token \
-H "Content-Type: application/json" \
-d '{
"client_key": "your-client-api-key",
"code": "one-time-code",
"redirect_uri": "https://example.com/auth/callback"
}'
```
Store the returned `access_token` in secure server-side storage, an HTTP-only secure session cookie, Keychain, or Keystore.
```bash theme={null}
curl https://api.thefaithapp.com/v1/user \
-H "X-API-Key: your-client-api-key" \
-H "Authorization: Bearer your-member-access-token" \
-H "Accept: application/json"
```
A successful response contains `status: "Success"` and the member record in `data`.
## JavaScript example
```javascript theme={null}
const response = await fetch('https://api.thefaithapp.com/v1/user', {
headers: {
Accept: 'application/json',
'X-API-Key': process.env.THEFAITHAPP_CLIENT_KEY,
Authorization: `Bearer ${memberAccessToken}`,
},
});
if (!response.ok) {
const error = await response.json();
throw new Error(error.message ?? error.error_message ?? 'TheFaithApp request failed');
}
const { data: member } = await response.json();
```
Do not put a production client API key or member access token in frontend source code. Proxy sensitive calls through your backend when your runtime cannot protect credentials.
## Next steps
* Building with Flutter? Follow the [Flutter SDK Quickstart](/api-reference/flutter-sdk).
* Building with React Native or Expo? Follow the [React Native SDK Quickstart](/api-reference/react-native-sdk).
* Adding in-app giving to Flutter? Follow the [Flutter Giving SDK](/api-reference/flutter-giving-sdk).
* Adding in-app giving to React Native or Expo? Follow the [React Native Giving SDK](/api-reference/react-native-giving-sdk).
* Read the [Hosted Auth Guide](/api-reference/hosted-auth) before implementing production sign-in.
* Review [Pagination and Errors](/api-reference/pagination-and-errors) for resilient response handling.
* Open an endpoint in the reference to see generated cURL, JavaScript, and Python examples.
# React Native Giving SDK
Source: https://docs.thefaithapp.com/api-reference/react-native-giving-sdk
Add authenticated general and campaign giving with Stripe, PayPal, and Flutterwave to a React Native or Expo app.
# Add giving to a React Native app
The `@thefaithapp/giving-react-native` package renders general and campaign
giving inside a React Native or Expo app. It uses the member session from
`@thefaithapp/auth-react-native`, presents the church's active payment
provider, and waits for TheFaithApp to confirm the payment.
The package includes:
* general giving with funds, currency, frequency, memo, and fee coverage
* campaign giving with configured donor form fields
* Stripe PaymentSheet
* hosted PayPal and Flutterwave checkout
* checkout cancellation and expiry handling
* headless checkout and custom payment-handler support
TheFaithApp creates and verifies each checkout and processes provider webhooks.
Do not add payment-provider secret keys or webhook secrets to your mobile app.
## Before you begin
You need:
* an Expo SDK 57 or compatible React Native app
* `@thefaithapp/auth-react-native` configured with a client API key
* a signed-in TheFaithApp member
* an active payment provider configured for the church
* a native development or standalone build
Follow the [React Native SDK Quickstart](/api-reference/react-native-sdk) first
if member sign-in is not working yet.
Install the auth and giving SDKs:
```bash theme={null}
npm install @thefaithapp/auth-react-native @thefaithapp/giving-react-native
```
Add the native payment dependencies with Expo-compatible versions:
```bash theme={null}
npx expo install @stripe/stripe-react-native react-native-webview
npx expo install expo-application expo-crypto expo-secure-store expo-web-browser
```
Add an application scheme, the auth plugin, and the Stripe plugin to
`app.json`:
```json theme={null}
{
"expo": {
"scheme": "your-church",
"plugins": [
"@thefaithapp/auth-react-native",
[
"@stripe/stripe-react-native",
{
"merchantIdentifier": "merchant.com.example.church",
"enableGooglePay": false
}
],
"expo-secure-store",
"expo-web-browser"
],
"ios": {
"bundleIdentifier": "com.example.church"
},
"android": {
"package": "com.example.church"
}
}
}
```
Rebuild the native application after changing plugins:
```bash theme={null}
npx expo run:ios
# or
npx expo run:android
```
Stripe PaymentSheet cannot run in Expo Go.
Reuse the auth instance that signs the member in:
```tsx theme={null}
import { TheFaithAppAuth } from '@thefaithapp/auth-react-native'
import {
TheFaithAppGiving,
createStripeGivingPaymentHandler,
} from '@thefaithapp/giving-react-native'
const auth = new TheFaithAppAuth({
apiKey: process.env.EXPO_PUBLIC_THEFAITHAPP_API_KEY!,
})
const giving = new TheFaithAppGiving({
auth,
paymentHandlers: [
createStripeGivingPaymentHandler({
urlScheme: 'your-church',
returnUrl: 'your-church://stripe-redirect',
}),
],
})
```
The Stripe override adds the return URL used by redirect and 3DS flows. Its
provider ID replaces the built-in Stripe handler while PayPal and
Flutterwave continue to use their built-in handlers.
Before showing protected giving:
```tsx theme={null}
const session = (await auth.currentSession()) ?? (await auth.signIn())
console.log(`Giving as ${session.member.name}`)
```
The giving client does not accept a member ID or church/client ID. The
authenticated session supplies that identity on every request.
Add the built-in general giving view to a screen:
```tsx theme={null}
import { GeneralGivingView } from '@thefaithapp/giving-react-native'
export function GivingScreen() {
return (
{
// result.state is succeeded, pending, failed, or cancelled.
}}
onError={(error) => {
// Show a safe message without logging checkout data.
}}
/>
)
}
```
The view loads the church's giving settings and funds. It shows only the
currencies, recurrence options, memo, and fee coverage allowed by that
configuration.
Your app chooses the campaign, then passes its numeric ID to the view:
```tsx theme={null}
import { CampaignGivingView } from '@thefaithapp/giving-react-native'
export function CampaignScreen({
campaignId,
}: {
campaignId: number
}) {
return (
{
// Handle succeeded, pending, failed, or cancelled.
}}
/>
)
}
```
If the campaign has donor fields, the package renders and validates its
text, multiline text, number, email, telephone, select, radio, checkbox,
and date fields.
Campaign discovery and selection belong to your app. The package begins
with the campaign ID you provide.
## Payment-provider behavior
The package uses the church's active/default provider. An app does not choose
between Stripe, PayPal, and Flutterwave for an individual gift.
| Provider | Experience |
| ----------- | ------------------------------------ |
| Stripe | Native PaymentSheet |
| PayPal | Hosted approval in an in-app WebView |
| Flutterwave | Hosted checkout in an in-app WebView |
The result from a native sheet or WebView is not treated as proof of payment.
The SDK checks TheFaithApp's webhook-backed status before reporting the final
state. A `pending` result means the provider or webhook is still processing.
## Campaign fields
The built-in campaign view loads the campaign definition and submits its form
responses with the authenticated checkout. Required fields are validated
before the payment experience opens.
Both giving views accept partial `strings` overrides,
`contentContainerStyle`, `allowRecurring`, and `showMemo`.
## Headless checkout
The rendered views are optional. A custom form can create an authenticated
checkout and render the shared payment host:
```tsx theme={null}
const checkout = await giving.createGeneralCheckout({
allocations: [{ amount: 25, fundId: 4 }],
currency: 'USD',
frequency: 'one_time',
})
```
For a campaign, call `createCampaignCheckout(campaignId, request)` and include
the campaign's configured values in `request.formFields`.
Keep the host mounted until the provider completes. If your custom UI
dismisses an unrendered checkout, report it:
```tsx theme={null}
await giving.abandonCheckout(checkout)
```
## Add another payment provider
Register a handler whose `provider` matches the value configured on
TheFaithApp:
```tsx theme={null}
import type {
GivingPaymentHandler,
GivingPaymentHandlerProps,
} from '@thefaithapp/giving-react-native'
function ChurchPay({
checkout,
onComplete,
onError,
}: GivingPaymentHandlerProps) {
// Present the provider UI and confirm authoritative checkout status.
return null
}
const churchPayHandler: GivingPaymentHandler = {
provider: 'church-pay',
Component: ChurchPay,
}
const giving = new TheFaithAppGiving({
auth,
paymentHandlers: [churchPayHandler],
})
```
A handler receives only one checkout's ephemeral session and narrow completion
capabilities. It does not receive the auth client, client API key, bearer
token, member ID, or church ID.
Never persist or log checkout provider data. A custom handler must complete
with the same donation ID and provider it received.
## Cancellation and cleanup
Closing a payment experience triggers a best-effort checkout abandonment
request. If the device is offline or the app terminates before that request
arrives, TheFaithApp expires the checkout on the server. A late valid webhook
still has a short grace period so a completed payment is not incorrectly
cancelled.
## Troubleshooting
| Problem | What to check |
| ------------------------------------ | ------------------------------------------------------------------------------------------------------ |
| Giving says it is unavailable | Confirm the church has an active/default payment provider and supported giving configuration. |
| The member is not authenticated | Restore or create the auth session before rendering the giving view. |
| Stripe does not open | Use a native development build, rebuild after adding the plugin, and confirm the Stripe return scheme. |
| The app does not return after 3DS | Confirm `returnUrl` uses the scheme registered in `app.json`. |
| A campaign cannot be loaded | Confirm the campaign ID belongs to the signed-in member's church and the campaign is available. |
| A required campaign field is missing | Render the campaign returned by the package instead of maintaining a separate field definition. |
| A payment remains pending | Keep the status message visible; TheFaithApp updates the donation when the provider webhook arrives. |
## Package resources
* [Package on npm](https://www.npmjs.com/package/@thefaithapp/giving-react-native)
* [Source and standalone example](https://github.com/thefaithapp/thefaithapp-giving-react-native)
# React Native SDK Quickstart
Source: https://docs.thefaithapp.com/api-reference/react-native-sdk
Add hosted member sign-in and authenticated v1 API requests to an iOS or Android React Native app.
# Use the API from React Native
The `@thefaithapp/auth-react-native` package signs a member in through
TheFaithApp and sends authenticated `v1` API requests from React Native and
Expo apps. Your app does not need to host a callback website.
## Before you begin
You need:
* an Expo SDK 57 app targeting iOS or Android
* its Android application ID and iOS bundle ID
* a client API key from `Settings > Developer Access`
Install the SDK and its Expo modules:
```bash theme={null}
npm install @thefaithapp/auth-react-native
npx expo install expo-application expo-crypto expo-secure-store expo-web-browser
```
Add the SDK plugin and your application identifiers to `app.json`:
```json theme={null}
{
"expo": {
"plugins": ["@thefaithapp/auth-react-native"],
"ios": {
"bundleIdentifier": "com.example.app"
},
"android": {
"package": "com.example.app"
}
}
}
```
The plugin adds the mobile callback to both native projects when you build
the app.
In the TheFaithApp dashboard:
1. Open `Settings > Developer Access`.
2. Click **Add React Native app**.
3. Append `.thefaithapp` to your application ID.
4. Add the app and copy your client API key.
For an application ID of `com.example.app`, enter:
```text theme={null}
com.example.app.thefaithapp
```
The dashboard creates the callback expected by the package:
```text theme={null}
com.example.app.thefaithapp://auth/callback
```
If iOS and Android use different identifiers, register both callbacks.
Avoid underscores because they cannot be used in a callback URI scheme.
Rebuild the app so the native callback configuration is included:
```bash theme={null}
npx expo run:ios
# or
npx expo run:android
```
Use a development build or standalone app for this flow. Expo Go cannot be
rebuilt with your application's callback scheme.
Provide the client key when creating `TheFaithAppAuth`:
```tsx theme={null}
import { TheFaithAppAuth } from '@thefaithapp/auth-react-native'
const auth = new TheFaithAppAuth({
apiKey: process.env.EXPO_PUBLIC_THEFAITHAPP_API_KEY!,
})
```
Supply the value from your development or build environment instead of
committing it to source control.
Start sign-in from a button or another user action:
```tsx theme={null}
const session = await auth.signIn()
console.log(session.member.name)
```
The package returns to the app after hosted sign-in and stores the member
session securely.
Use `authorizedFetch` for protected API requests:
```tsx theme={null}
const response = await auth.authorizedFetch('/v1/user')
const body = await response.json()
if (!response.ok) {
throw new Error(body.message ?? 'The request failed.')
}
```
Pass another relative `/v1/...` path to call endpoints from the API
Reference.
## Restore the saved session
Check for a saved session when the app starts:
```tsx theme={null}
const session = await auth.currentSession()
if (session) {
console.log(`Welcome back, ${session.member.name}`)
}
```
## Access the bearer token
When an integration needs the token directly:
```tsx theme={null}
const token = await auth.accessToken()
```
Do not log the token or include it in analytics and crash reports.
## Sign out
Revoke the member session and remove its saved copy:
```tsx theme={null}
await auth.signOut()
```
## Handle SDK errors
```tsx theme={null}
import { TheFaithAuthError } from '@thefaithapp/auth-react-native'
try {
await auth.signIn()
} catch (error) {
if (error instanceof TheFaithAuthError && error.code === 'cancelled') {
// The member closed the sign-in session.
}
}
```
## Troubleshooting
| Problem | What to check |
| -------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
| The redirect is rejected | Confirm the value added with **Add React Native app** matches the application ID with `.thefaithapp` appended. |
| The app does not reopen after sign-in | Rebuild the native app after adding the config plugin and confirm the installed application ID. |
| Sign-in does not return while using Expo Go | Create an Expo development build or standalone app. |
| A protected request says the member is not authenticated | Call `signIn()` or restore a saved session before sending the request. |
## Next steps
* Add authenticated general and campaign giving with the
[React Native Giving SDK](/api-reference/react-native-giving-sdk).
* Browse the endpoint groups in the API Reference navigation.
* Read [Pagination and Errors](/api-reference/pagination-and-errors) before
loading lists or adding retry behavior.
* Use the public
[standalone sample](https://github.com/thefaithapp/thefaithapp-auth-react-native/tree/main/example)
as a compact reference implementation.
# App customization is now available
Source: https://docs.thefaithapp.com/changelog/2026-05-15-app-customization-is-now-available
Design and publish a branded mobile app experience for your church.
# App customization is now available
*May 15, 2026*
[Back to changelog](/changelog/index)
Church teams can now shape a more branded mobile app experience inside TheFaithApp. App Customization brings your theme, navigation, custom pages, reusable content blocks, preview tools, and release controls into one workflow.
![Page builder workspace]()
## What's New
* Choose your app colors, typography style, corner radius, and theme behavior from `Brand & Theme`.
* Build a custom navigation experience for the tabs members see in the mobile app.
* Create custom pages with text, images, buttons, cards, sections, and reusable content blocks.
* Reuse content carousels across multiple pages from the component library.
* Preview your work in phone and tablet layouts before publishing.
* Publish releases when you are ready, then decide whether the live app should use the latest custom design.
## Why It Matters
App Customization gives churches more control over how their mobile experience looks and feels without requiring a full rebuild for every change. Teams can prepare updates in stages, review them, and publish when they are ready.
## Where You'll Use It
* `Settings > Branding` still manages white-label branding, domains, and public-page styling.
* `App Customization > Brand & Theme` controls the visual foundation for the mobile experience.
* `App Customization > Navigation` manages app tabs and destinations.
* `App Customization > Page Builder` is where custom pages are created and updated.
* `App Customization > Component Library` stores reusable blocks you can place across pages.
* `App Customization > Releases` is where teams publish a live version and turn `Use custom design` on or off.
![Customization releases]()
## What Members Will Notice
When a release is live, members can see the updated navigation and custom pages directly in the mobile app. This makes it easier to tailor the app around your church's content, campaigns, and priorities.
## Learn More
Read the full setup guide in [Settings, Branding, and App Customization](/product/settings-branding-and-customization).
# App customization is now available to all admins
Source: https://docs.thefaithapp.com/changelog/2026-05-29-app-customization-is-now-available-to-all-admins
The app customization workspace no longer requires the earlier rollout gate.
# App customization is now available to all admins
*May 29, 2026*
[Back to changelog](/changelog/index)
The App Customization workspace is now open to all admins. Teams no longer need the earlier rollout gate before opening the page builder, navigation editor, component library, and brand theme workspace.
## What's Changed
* `App Customization` now appears directly in the admin product picker.
* Admins can open the workspace without waiting for the earlier staged rollout.
* Existing customization tools, previews, and releases continue to work the same way.
## Why This Matters
Church teams can now start shaping their mobile app experience without needing a separate access step. This makes the workspace easier to discover and easier to adopt across more admins.
## Learn More
Read the full guide in [Settings, Branding, and App Customization](/product/settings-branding-and-customization).
# Sermon AI tools are now available
Source: https://docs.thefaithapp.com/changelog/2026-06-09-sermon-ai-tools-are-now-available
Generate reviewed sermon transcripts, chapters, insights, translations, quote cards, content drafts, and uploaded-video clips.
# Sermon AI tools are now available
*June 9, 2026*
[Back to changelog](/changelog/index)
Sermon AI is now available for churches using TheFaithApp. Admins can turn uploaded sermons into reviewed transcripts, member study tools, translations, shareable content, quote cards, and short video clips.
## What's New
* Generate synced transcripts for uploaded audio sermons and uploaded video sermons.
* Review, edit, publish, or unpublish transcripts before members see them.
* Create sermon chapters so members can jump to key moments.
* Generate sermon insights, including summaries, key points, scripture references, reflection questions, and discussion prompts.
* Translate reviewed transcripts into supported languages.
* Create social posts, short snippets, newsletter blurbs, and bulletin announcements from sermon content.
* Design and download quote cards from sermon excerpts.
* Suggest and render downloadable clips from uploaded video sermons.
## Why This Matters
Church teams can make sermons easier to revisit, search, translate, study, and share without asking members to pay for access. Staff stay in control because generated content can be reviewed before it is published.
## Learn More
Read the full workflow in [Content Management](/product/content-management#sermon-ai-tools).
# Chat realtime is now powered by Firebase
Source: https://docs.thefaithapp.com/changelog/2026-06-10-chat-realtime-is-now-powered-by-firebase
Chat messages, typing states, and room updates now arrive faster across web and mobile.
# Chat realtime is now powered by Firebase
*June 10, 2026*
[Back to changelog](/changelog/index)
Chat now uses Firebase Realtime Database for live updates across the admin web dashboard and the mobile app. Message records still stay in TheFaithApp's database, while Firebase handles the fast room updates members expect during an active conversation.
## What's New
* New messages appear in open chat rooms without waiting for a full page refresh.
* Typing indicators update across supported chat surfaces.
* Chat participants, room access, and message activity stay in sync between web and mobile.
* The older Laravel Reverb realtime layer has been removed from chat.
## Why This Matters
Chat now feels more immediate while keeping TheFaithApp's database as the source of truth for message history, membership, moderation, and reporting.
# Chat rooms have stronger admin controls
Source: https://docs.thefaithapp.com/changelog/2026-06-11-chat-rooms-have-stronger-admin-controls
Admins can now manage room behavior with moderation, read states, mentions, reactions, and notification preferences.
# Chat rooms have stronger admin controls
*June 11, 2026*
[Back to changelog](/changelog/index)
Chat rooms now include stronger controls for keeping conversations organized, safe, and easier to follow.
## What's New
* Admins can delete inappropriate messages.
* Admins can pin or unpin important messages.
* Rooms can be locked when posting should pause.
* Members can be muted or restricted from posting when needed.
* Mentions help people call attention to specific members in group chats.
* Message reactions let members respond quickly with lightweight faith-community reactions.
* Read receipts and unread dividers make it clearer where a member left off.
* Per-room notification preferences let members mute conversations for a set time or turn off alerts for a room.
## Why This Matters
Church teams can keep group conversations healthier without losing the quick, friendly rhythm of chat.
# Sermon AI content is available in the external API
Source: https://docs.thefaithapp.com/changelog/2026-06-11-sermon-ai-content-is-available-in-the-external-api
Third-party apps can now read published sermon transcripts, chapters, and insights.
# Sermon AI content is available in the external API
*June 11, 2026*
[Back to changelog](/changelog/index)
Third-party apps using the TheFaithApp `v1` API can now read published sermon transcripts, chapter markers, and sermon insights for audio sermons and uploaded video sermons.
## What's Changed
* `GET /v1/media/{mediaId}/transcript` returns the published synced transcript, cue timestamps, available languages, and published translations.
* `GET /v1/media/{mediaId}/chapters` returns published chapter markers.
* `GET /v1/media/{mediaId}/insights` returns the published summary, key points, scripture references, reflection questions, and discussion prompts.
* Audio, video, and category media lists include `has_transcript` so apps can decide when to show transcript controls before downloading cue data.
## Why This Matters
Churches can bring reviewed sermon AI content into custom mobile apps, websites, and partner experiences while keeping unpublished drafts private.
## Learn More
Read the API reference for [sermon transcripts](/api-reference/endpoints/content/get-sermon-transcript), [sermon chapters](/api-reference/endpoints/content/get-sermon-chapters), and [sermon insights](/api-reference/endpoints/content/get-sermon-insights).
# Chat conversations are easier to follow
Source: https://docs.thefaithapp.com/changelog/2026-06-12-chat-conversations-are-easier-to-follow
Chat now has better room lists, timeline grouping, search, presence, reply navigation, and group details.
# Chat conversations are easier to follow
*June 12, 2026*
[Back to changelog](/changelog/index)
The chat experience has been polished across web and mobile so members can find the right room, catch up faster, and understand who is active.
## What's New
* Chat lists now show the latest message and unread counts.
* Messages are grouped by timeline labels such as Today, Yesterday, and older dates.
* Infinite scroll now keeps older messages in the correct order while loading more history.
* Room search helps find messages by text, sender, attachments, and sermon attachments.
* Tapping a quoted reply scrolls to the original message and highlights it.
* Group details now show members, photos, files, and shared sermons.
* Member lists support loading more members in larger rooms.
* Presence and last-seen states help show who is currently around.
* Members can open public rooms before joining, then join from inside the room when they are ready to participate.
## Why This Matters
Busy chat rooms are easier to scan, catch up on, and trust because the room state no longer feels disconnected between the list, the message feed, and the group details.
# Chat attachments, voice notes, and sermon sharing are upgraded
Source: https://docs.thefaithapp.com/changelog/2026-06-13-chat-attachments-voice-notes-and-sermon-sharing-are-upgraded
Chat now supports richer image, PDF, voice note, and sermon attachment experiences across web and mobile.
# Chat attachments, voice notes, and sermon sharing are upgraded
*June 13, 2026*
[Back to changelog](/changelog/index)
Chat attachments now feel more like a modern messaging experience, with richer previews and better playback for media shared inside a conversation.
## What's New
* Images display directly in chat bubbles and can be opened in a larger preview.
* PDF attachments can be opened from inside chat.
* Attachment handling is focused on the currently supported file types: images and PDFs.
* Upload progress gives clearer feedback while a file is being sent.
* Multiple image attachments can be viewed more naturally as a gallery.
* Members can download or share supported attachments where the app surface allows it.
* Mobile users can record and send voice notes.
* Sermons can be attached to chat messages from the sermon picker.
* Audio and video sermon cards show useful playback information and open in the appropriate in-app or browser player.
* The now-playing chat experience shows progress and lets members return to the active sermon more easily.
## Why This Matters
Members can share more than text without leaving the conversation, and sermon attachments now connect chat directly to the listening and watching experience.
# Prayer Community adds a church prayer feed
Source: https://docs.thefaithapp.com/changelog/2026-06-17-prayer-community-adds-a-church-prayer-feed
Members can now share approved prayer requests, mark that they prayed, and follow up when prayers are answered.
# Prayer Community adds a church prayer feed
*June 17, 2026*
[Back to changelog](/changelog/index)
Prayer Community adds a member-facing prayer feed for each church.
## What's New
* Members can open the Prayer Community from the Connect page.
* Members can submit prayer requests from the mobile app.
* Approved prayer requests appear in a church-scoped feed.
* Pending or rejected requests stay out of the community feed.
* Members can tap `I prayed` to show support for a request.
* `I prayed` is counted once per member for each request.
* Members can review their own submitted requests.
* Request owners can mark their own requests as answered.
* Answered requests can include optional testimony text.
* Anonymous requests hide requester identity in the feed.
* Non-anonymous requests can show the member or display name.
## Why This Matters
Prayer requests no longer stop at private submission. Churches can build a simple prayer loop where members share needs, pray together, and celebrate answered prayers while the existing approval process remains the moderation gate.
# Prayer Rooms beta is ready for mobile testing
Source: https://docs.thefaithapp.com/changelog/2026-06-17-prayer-rooms-beta-is-ready-for-mobile-testing
Members can now create and join beta audio and video prayer rooms, use room controls, and give toward room goals.
# Prayer Rooms beta is ready for mobile testing
*June 17, 2026*
[Back to changelog](/changelog/index)
Prayer Rooms are now available as a beta experience from the mobile Connect page.
## What's New
* Members can open `Connect` and enter the `Prayer Rooms` beta area.
* Hosts can create audio or video prayer rooms and move directly into the room.
* Rooms support speaker, listener, host, and moderator behavior.
* Audio rooms show connected participants, mute state, and speaking state.
* Video rooms use a compact meeting layout with participant controls.
* Hosts can end a room and remove participants from the live session.
* Rooms can be locked, scheduled, recurring, or configured with recording consent.
* Recording and prayer clip workflows support consent-aware room settings.
* Room giving can be enabled with a goal amount.
* Native room giving is used when the church has a connected payment provider.
* External giving links remain available as a fallback when native payment setup is not ready.
* The room view can show tracked giving progress for native gifts.
## Why This Matters
Prayer Rooms give churches a live ministry space for prayer, support, and hosted gatherings without requiring a separate meeting tool.
The beta label helps teams test the experience carefully while audio, video, recording, and room giving continue through final QA.
# Hosted member sign-in simplifies API access
Source: https://docs.thefaithapp.com/changelog/2026-06-19-hosted-member-sign-in-simplifies-api-access
External apps can now use TheFaithApp-hosted member sign-in, with setup docs and API reference pages for the full auth flow.
# Hosted member sign-in simplifies API access
*June 19, 2026*
[Back to changelog](/changelog/index)
External apps can now connect to TheFaithApp with a simpler hosted member sign-in flow. Churches no longer need to upload their own Firebase service account just to let members sign in from a connected app.
## What's New
* Developer Access now provides a client key for connected apps.
* Admins can add Redirect URLs for web callbacks and mobile deep links.
* Members sign in through TheFaithApp-hosted auth and return with a short-lived code.
* Connected apps exchange that code for a member bearer token before calling the `v1` API.
* The API docs now include the full hosted auth setup guide, endpoint reference, mobile redirect guidance, and PKCE examples.
* Hosted auth stays on the TheFaithApp auth host, even when a church uses a custom public domain.
## Why This Matters
Connected apps are easier to set up, and TheFaithApp can manage the member authentication flow without exposing platform Firebase credentials or requiring each church to bring its own Firebase project.
# Prayer Rooms trial limits protect live room capacity
Source: https://docs.thefaithapp.com/changelog/2026-06-22-prayer-rooms-trial-limits-protect-live-room-capacity
Trial Prayer Rooms now default to smaller gatherings with monthly participant-minute metering before upgrading.
# Prayer Rooms trial limits protect live room capacity
*June 22, 2026*
[Back to changelog](/changelog/index)
Prayer Rooms trial usage now has clearer live-room limits before a church upgrades to Prayer Rooms Plus.
## What's Changed
* Trial rooms now default to 10 participants.
* Trial usage supports one live room at a time.
* Trial usage includes 500 participant minutes per billing period.
* Larger live rooms require Prayer Rooms Plus.
* Members see a clearer upgrade message when a room reaches the trial or participant-minute limit.
## Why This Matters
These limits keep the beta useful for testing while protecting live audio and video capacity as churches begin using Prayer Rooms.
# Member Directory connects your church
Source: https://docs.thefaithapp.com/changelog/2026-06-27-member-directory-connects-your-church
Members can browse a privacy-first church directory, control what they share, and staff can manage households, approvals, and reminders.
# Member Directory connects your church
*June 27, 2026*
[Back to changelog](/changelog/index)
The Member Directory gives each church a privacy-first way for members to find and connect with one another.
## What's New
* Members can browse and search the church directory from the mobile app, and keep browsing offline from the last list they loaded.
* Member profiles show only what each person has chosen to share.
* Contact details, location, birthday, and household are private by default.
* Members control their own visibility: a master directory switch, whole-profile visibility (everyone, leaders only, or hidden), and per-field settings — reachable from both the directory and the profile page.
* Members can open a household to see a family together, and see a "Birthdays this week" view.
* Members can set a profile photo and see their household (read-only) when editing their profile.
* When a church requires approval, sensitive profile edits are submitted for staff review with a clear confirmation, while other changes save right away.
* Staff can configure the directory, manage households (adding members by searching for them by name or email), and designate directory leaders from the web dashboard.
* Staff can require approval for sensitive profile edits and review them in a change-request queue.
* Churches can opt in to a daily birthday and anniversary digest for directory leaders.
* Children are excluded from the directory by default.
## Why This Matters
Connection is hard when people can't find each other, but a directory shouldn't come at the cost of privacy. The Member Directory lets members reach the right person while staying in control of what they share — and gives staff the tools to keep households organized and sensitive changes reviewed.
# Member Connections brings campuses, ministries, and groups together
Source: https://docs.thefaithapp.com/changelog/2026-07-10-member-connections-and-community-groups
Members can manage church connections, discover community groups, and use privacy-safe directory filters.
Member Connections is now available across mobile, web, and the Member Directory.
Members can:
* Review active and pending campus, ministry, and Community Group connections.
* Request campus or ministry connections and choose directory visibility.
* Browse Community Groups and join open groups or request approval.
* Leave connections that are no longer current.
* Filter the Member Directory by campus, ministry, Community Group, and general
location.
Staff can:
* Assign member connections and choose roles or a primary campus.
* Approve or decline connection requests.
* Configure campus and ministry approval rules.
* Create, edit, activate, and archive Community Groups.
* Publish announcements and study guides, review discussion activity, record
attendance, and maintain leader-only notes.
Members can participate in group discussions and read shared study guides after
joining a group.
Community Groups are separate from admin Permission Groups. Directory results
use only active, approved connections that members have chosen to show, and
location filtering never exposes a private street address.
# Member data hygiene and migration tools are available
Source: https://docs.thefaithapp.com/changelog/2026-07-11-member-data-hygiene-and-migration
Staff can review, clean up, and safely migrate member records before using the directory.
# Member data hygiene and migration tools are available
The Members workspace now includes a **Data hygiene** tab for keeping directory
records accurate and privacy-aware.
* Review duplicate records and confirm safe merges.
* Preview and apply address normalization.
* Audit missing profile fields and directory consent.
* Review accepted, failed, and skipped import rows.
* Use guided CSV column mapping for Planning Center, Breeze, Subsplash, and
Tithe.ly exports.
Migrations use exported files rather than direct third-party account access,
and duplicate merges archive the source record instead of permanently deleting
it.
# Your church week now meets you on Home
Source: https://docs.thefaithapp.com/changelog/2026-07-14-your-church-week-now-meets-you-on-home
The mobile Home screen brings together personal commitments, useful next steps, group updates, saved sermon moments, and quick actions.
# Your church week now meets you on Home
The mobile Home screen now gives every member a clearer view of what matters to
them today.
* See your next registered event, Community Group meeting, or serving
commitment.
* Jump to giving, prayer, event check-in, chat, or sermons from one row.
* Get one practical next-step suggestion based on your existing connections.
* Read announcements from Community Groups you have joined.
* Reopen saved sermons and personal sermon moments.
* Continue an unfinished audio sermon from the position saved on your device.
* Keep these personal sections when your church uses a published custom Home
design.
* Read Home headings, actions, commitment context, and recommendations in your
selected app language.
* See a calm, localized all-caught-up state when no personal commitments,
circle updates, saved items, or listening progress need attention.
Sections appear only when they are useful, so the church's normal bulletins,
sermons, events, and devotionals remain easy to browse.
# Welcome every new visitor with one connected journey
Source: https://docs.thefaithapp.com/changelog/2026-07-16-welcome-every-new-visitor-with-one-connected-journey
Guests can plan a visit or connect without an account while staff coordinate consent-aware follow-up and useful next steps.
# Welcome every new visitor with one connected journey
Churches can now guide a guest from first interest to meaningful follow-up in
one connected workflow.
* Publish campus arrival, parking, kids, accessibility, gathering, map, image,
and theme information on a public Plan a Visit page.
* Share direct visitor links or embed Plan a Visit and Connect Card forms in a
church website.
* Receive anonymous guest submissions in a searchable Visitor Inbox without
adding them to the member directory, with safe retry and spam safeguards.
* Assign owners, check in first visits, record no-shows, add private notes, and
keep the full relationship timeline together.
* Configure consent-aware confirmations, personal welcome tasks, overdue
reminders, pastor-call escalation, and optional newcomer-event invitations.
* Pause, resume, reassign, retry, skip, or complete follow-up steps.
* Show only next steps that lead to a campus, group, event, serving, prayer,
visit, Connect Card, or pastor-care experience that is ready to use.
* Link or convert a visitor to a member while preserving the visitor history
and reviewing exact Visitor or Member contact matches first; records are not
merged automatically.
* Connect a church-owned Handwrytten account and deliberately send a
consent-first physical welcome card with test/live warnings, reusable
defaults, staff approval, status history, and safe failure handling.
Email, text, and phone permission remain separate throughout the journey, and
pending automated follow-up stops when a visitor is closed or converted.
# Flutter apps can plug into hosted sign-in
Source: https://docs.thefaithapp.com/changelog/2026-07-18-flutter-apps-can-plug-into-hosted-sign-in
Developers can register a Flutter app in Developer Access and use the new SDK to receive a member bearer token without hosting a callback website.
# Flutter apps can plug into hosted sign-in
Developer Access now includes **Add Flutter app**. Enter the app's package name
with `.thefaithapp` appended, and TheFaithApp creates the matching mobile
callback automatically.
The new Flutter SDK opens TheFaithApp's hosted member sign-in, returns the
member to the installed app, stores the member session securely, and provides
an authenticated client for the `v1` API. Developers provide only the client
API key.
Mobile developers no longer need to host a separate callback website just to
receive the authorization result. A standalone sample app is also available
for testing the complete sign-in and API flow on iOS and Android. The API
Reference includes a Flutter quickstart covering installation, app
registration, sign-in, authenticated requests, session restoration, and
logout.
# React Native apps can use hosted sign-in
Source: https://docs.thefaithapp.com/changelog/2026-07-18-react-native-apps-can-use-hosted-sign-in
Developers can add hosted member sign-in to React Native and Expo apps without running a callback website.
# React Native apps can use hosted sign-in
Developer Access now includes **Add React Native app**. Enter the application
ID with `.thefaithapp` appended, and TheFaithApp creates the matching mobile
callback automatically.
The React Native SDK opens hosted member sign-in, returns a bearer token, saves
the member session securely, and sends authenticated `v1` API requests. Its
Expo config plugin adds the callback to the generated iOS and Android projects.
The API Reference includes a complete React Native and Expo quickstart covering
installation, callback registration, native builds, sign-in, API requests,
session restoration, and logout.
Current-member responses now include only the public church context apps need.
# Forms connects church intake to follow-up
Source: https://docs.thefaithapp.com/changelog/2026-07-21-forms-connect-intake-to-follow-up
Churches can build, publish, share, and embed flexible forms, then assign and complete every response from one organized inbox.
# Forms Connects Church Intake to Follow-Up
**Forms** is now a top-level TheFaithApp product for collecting information and
coordinating what happens next. Churches can begin with a blank form or one of
15 church-focused templates, arrange questions in the visual builder, control
who may respond, and publish an immutable version when it is ready.
![The Forms library]()
Share a form through its public link, a QR code, WhatsApp, the member app, or an
embed on the church website. Public pages keep the church's configured domain,
theme, schedule, access rules, and response limit. Known members can receive
safe prefills, while invite-only forms use individually tracked invitations.
Every submission arrives in the **Response Inbox**. Staff can search and filter
responses, choose visible columns, save views, assign an owner, set a priority
or due date, add private notes, and complete follow-up with a clear activity
history. Restricted and sensitive forms can be limited to named managers, and
exports apply the same access protections as the inbox.
Forms is responsive across desktop, tablet, and phone layouts. The builder,
public form, and response inbox also support keyboard navigation, dark mode,
right-to-left languages, and browser text scaling for more accessible use.
Forms also connects reviewed responses to existing church workflows such as
visitors, member journeys, events, volunteering, groups, prayer requests, and
Outreach review. These connections are deliberate actions rather than automatic
copies.
Forms remains separate from **Outreach Campaigns → Donor Forms**. Donor Forms
continues to collect campaign-specific supporter information, while the Forms
product serves broader church intake and follow-up.
Read the [Forms product guide](/product/forms) for the complete setup,
publishing, sharing, response-management, privacy, and lifecycle workflow.
# Handwrytten cards are ready for visitor follow-up
Source: https://docs.thefaithapp.com/changelog/2026-07-23-handwrytten-cards-are-ready-for-visitor-follow-up
Churches can connect Handwrytten and send consent-aware welcome cards from a visitor journey, with guarded sender setup, test or live review, and order tracking.
# Handwrytten Cards Are Ready for Visitor Follow-Up
Churches can now use their own Handwrytten account to prepare, review, send,
and track personal welcome cards from the visitor journey.
* Connect and test Handwrytten from **Settings** → **Integrations**, then see
the account mode, available credit, card designs, handwriting styles, and
default return address.
* If the account has no default sender, choose a saved Handwrytten address or
add one in TheFaithApp. A clear confirmation is required before the connected
account is changed.
* Open a visitor's **Handwrytten** tab, record postal-mail permission, choose a
design and handwriting style, and review the recipient, message, and return
address before submitting.
* Test orders remain clearly separated from live orders. Live approval warns
staff that the connected Handwrytten account will be charged and the card
will be mailed.
* Refresh submitted orders manually, review their status and provider response,
and cancel an order when Handwrytten still allows it.
* Keep every draft, submission, status update, and failure in the visitor
history without storing the church's payment-card details in TheFaithApp.
Handwrytten continues to own the address book, artwork, payment method,
printing, and mailing. TheFaithApp coordinates staff approval and visitor
history without silently changing the connected account.
# Pastoral prayer protects confidential care
Source: https://docs.thefaithapp.com/changelog/2026-07-23-pastoral-prayer-protects-confidential-care
Members can share an encrypted prayer request with a smaller, permission-controlled pastoral team.
# Pastoral prayer protects confidential care
*July 23, 2026*
[Back to changelog](/changelog/index)
Members can now choose `Pastoral team only` when a prayer request needs a
smaller confidentiality boundary than the general leaders-only workflow.
## What's New
* Members see a clear privacy explanation before sharing with the pastoral
team.
* Churches can grant private pastoral prayer access separately from ordinary
Prayer Requests access.
* Authorized caregivers can coordinate urgency and follow-up from the existing
prayer workspace.
* The request shows a safe access history so authorized staff can understand
when it was viewed or acted on.
## Privacy by Default
Pastoral prayer content is encrypted and stays out of Prayer Walls,
prayer-team lists and emails, Prayer Rooms, general exports, and AI tools.
Notifications use a general message without the prayer, identity, or contact
details.
Pastoral exports contain workflow metadata only. After a request is answered,
withdrawn, or rejected, the encrypted content is retained for the church's
configured period and then removed while the minimal accountability history
remains.
# Prayer requests add safer audience controls
Source: https://docs.thefaithapp.com/changelog/2026-07-23-prayer-requests-add-audience-controls
Members can share prayer requests with their church, a Community Group, or church leaders and retain control through editing and withdrawal.
# Prayer requests add safer audience controls
*July 23, 2026*
[Back to changelog](/changelog/index)
Prayer Community now gives each request an explicit audience while keeping
anonymity as a separate choice.
## What's New
* Members can choose the Church Prayer Wall, one of their active Community
Groups, or church leaders only.
* Group requests are available only to active members of the selected group.
* Public-form requests default to church leaders only.
* Members can edit an active request. Previously approved requests return for
staff review before appearing again.
* Members can withdraw a request without deleting the church's follow-up
record.
* The Prayer Wall separates active requests from answered prayers.
* Staff can see and filter request audiences and review answered or withdrawn
state.
## Why This Matters
Prayer needs do not all belong in the same room. The new controls let members
ask the right people to pray while churches retain a clear moderation and
follow-up workflow.
# Prayer teams coordinate daily care
Source: https://docs.thefaithapp.com/changelog/2026-07-23-prayer-teams-coordinate-daily-care
Churches can organize verified prayer volunteers around safe daily lists, assignments, availability, and weekly email digests.
# Prayer teams coordinate daily care
*July 23, 2026*
[Back to changelog](/changelog/index)
Prayer teams now have one shared workflow from church setup to a member's
daily prayer rhythm.
## What's New
* Staff can create prayer teams from volunteers who already passed the prayer
support verification and safeguarding process.
* Each team supports leader, coordinator, and intercessor roles, weekly
availability, active or paused status, and email preferences.
* Members see a focused daily list and can mark requests as praying or
completed.
* Staff can deliberately assign an eligible request to the whole team or one
team member.
* Active, opted-in team members receive a weekly prayer list by email.
## Privacy by Default
Automatic lists use approved church requests only. Leaders-only requests
require a staff assignment, Community Group requests stay out of team lists,
and anonymous requests remain anonymous. Team screens and emails do not expose
requester phone or email details.
# Private prayer journals build a personal prayer rhythm
Source: https://docs.thefaithapp.com/changelog/2026-07-23-private-prayer-journals-and-reminders
Members can keep prayers private, record answered reflections, share when ready, and choose daily, weekly, or one-time reminders.
# Private prayer journals build a personal prayer rhythm
*July 23, 2026*
[Back to changelog](/changelog/index)
Prayer Community now supports the personal side of prayer as well as the
shared Prayer Wall.
## What's New
* Members can record prayers in a journal that only they can access.
* Journal prayers can be marked answered with a private reflection.
* A member can copy a journal prayer into a moderated church, Community Group,
or leaders-only request when they are ready to share.
* Daily and weekly reminders help members build a regular prayer rhythm.
* One-time reminders support private journal prayers and follow-up on requests
the member owns or previously marked `I prayed`.
* Reminder notifications open Prayer Community without exposing a private
journal description on the lock screen.
## Why This Matters
Not every prayer begins as something to share. Members can now keep a private
record, notice answered moments, and invite others in only when it feels
appropriate.
# Urgent prayer connects members to timely follow-up
Source: https://docs.thefaithapp.com/changelog/2026-07-23-urgent-prayer-connects-timely-follow-up
Members can privately ask leaders for timely prayer support while churches coordinate a safe, owned response.
# Urgent prayer connects members to timely follow-up
*July 23, 2026*
[Back to changelog](/changelog/index)
Members can now privately ask church leaders for urgent follow-up on an active
prayer request.
## What's New
* Members can request urgent follow-up with a short private reason and see its
progress in `My Requests`.
* Authorized staff receive a safe alert, review the request, assign an owner,
and track acknowledgement, active follow-up, and resolution.
* Staff can create a bounded Pastoral Care handoff when broader coordination is
needed.
* An eligible request can open a locked Prayer Room for the member and a
verified prayer-team leader.
## Privacy by Default
Urgency never appears as a badge on the Prayer Wall. Alerts do not contain the
prayer text, requester identity, contact details, or private reason. Care
handoffs keep only the source reference and coordination details instead of
copying sensitive request content.
Urgent follow-up is a church ministry workflow and is not an emergency service.
# Pastoral Care connects private requests to follow-up
Source: https://docs.thefaithapp.com/changelog/2026-07-24-pastoral-care-connects-private-requests-to-follow-up
Members can confidentially ask for care while authorized church staff coordinate ownership, notes, tasks, and resolution.
# Pastoral Care connects private requests to follow-up
*July 24, 2026*
[Back to changelog](/changelog/index)
Members can now open `Pastoral Care` from the mobile Connect page and share a
confidential need directly with their church.
## What's New
* Members can request general care, a hospital visit, counseling, benevolence,
grief or illness support, crisis support, or pastoral follow-up.
* Members can choose urgency, privacy, and a preferred contact method, then
review, edit, or withdraw an open request.
* Authorized staff have one care queue for assignment, follow-up dates,
confidential notes, tasks, activity, and resolution.
* Prayer care handoffs can become linked care cases without copying the source
prayer text.
## Privacy by Default
Sensitive content is encrypted, ordinary and pastoral-only cases have separate
permission boundaries, and staff access is recorded. Notifications use general
language without member identity, request text, contact details, or care notes.
After a request is resolved or withdrawn, the private content is removed at the
end of the church's configured retention period while a minimal accountability
history remains.
# Pastoral Care coordinates visits and coverage
Source: https://docs.thefaithapp.com/changelog/2026-07-24-pastoral-care-coordinates-visits-and-coverage
Care teams can schedule visits, plan response coverage, share availability, and organize new-baby support.
# Pastoral Care coordinates visits and coverage
*July 24, 2026*
[Back to changelog](/changelog/index)
Pastoral Care now carries a confidential request through practical,
team-coordinated support without creating a separate record.
## What's New
* Authorized staff can schedule and complete hospital, home, and other care
visits inside a care request.
* A shared Coordination view brings upcoming visits, primary and backup
response coverage, recurring caregiver availability, and simple workload
counts together.
* New-baby requests can include a dated support plan, an assigned coordinator,
and requested help such as meals, visits, transport, supplies, or prayer.
* Members can review their own visit schedule and safe support-plan details in
the mobile app.
## Privacy Stays Intact
The existing church and permission boundaries apply to every coordination
view. Visit details, outcomes, support preferences, and private coordination
notes are encrypted, and member notifications do not include sensitive care
content.
Members never see staff-only support-plan or coverage notes. The retention
workflow removes private visit and support-plan content after the closed case
reaches the end of its configured retention period.
# Pastoral Care remembers member-approved moments
Source: https://docs.thefaithapp.com/changelog/2026-07-24-pastoral-care-remembers-member-approved-moments
Members can choose private follow-up dates and pause sensitive celebration messages.
# Pastoral Care remembers member-approved moments
*July 24, 2026*
[Back to changelog](/changelog/index)
Pastoral Care can now remember meaningful dates without turning private care
into public recognition.
## Member Control Comes First
* Reminders are off until a member explicitly enables them.
* Members can choose birthday, grief, illness, crisis, and hard-anniversary
follow-up separately.
* Each private date can be one-time or yearly, paused, edited, or permanently
removed.
* Members choose a contact method and whether a gentle message is welcome,
staff should ask first, or the date should be remembered without contact.
## Gentler Staff Follow-Up
The staff Life moments view shows member-approved dates, due follow-ups, and
eligible caregivers. Alerts use generic language and never include the
member's identity or the private moment.
Members can also pause automated birthday, wedding-anniversary, baby/family,
or all celebration recognition during a chosen quiet-day window. Restricted
reasons and guidance remain encrypted and visible only to appropriately
authorized pastoral staff.
Wedding preparation, baby dedication, funeral support, relocation support, and
pastoral recommendation requests now use the same confidential care casework
as other Pastoral Care requests.
# Mobile giving SDKs are available for Flutter and React Native
Source: https://docs.thefaithapp.com/changelog/2026-07-25-mobile-giving-sdks-are-available
Developers can add authenticated general and campaign giving without placing payment-processing endpoints or provider secrets in their apps.
# Mobile giving SDKs are available for Flutter and React Native
The new Flutter and React Native giving SDKs let a signed-in member give from a
church app using the church's active payment provider.
Both SDKs include ready-to-use general and campaign giving views. They load the
church's funds, currency and recurrence settings, campaign donor fields, memo
and fee-coverage options, then present Stripe, PayPal, or Flutterwave.
Developers do not need to publish or call the underlying payment-processing
routes directly. The SDKs use the authenticated member session, while
TheFaithApp creates the checkout, verifies its church and member scope,
processes provider webhooks, and owns the final payment status.
Payment presentation is extensible, so another provider can be added without
rebuilding the general and campaign forms. Custom handlers receive only
checkout-scoped data and narrow completion capabilities, never member IDs,
client IDs, API keys, bearer tokens, or webhook secrets.
The API Reference now includes complete setup and integration guides for:
* [`thefaithapp_giving`](https://pub.dev/packages/thefaithapp_giving) for Flutter
* [`@thefaithapp/giving-react-native`](https://www.npmjs.com/package/@thefaithapp/giving-react-native) for React Native and Expo
# Partner apps can offer confidential Pastoral Care
Source: https://docs.thefaithapp.com/changelog/2026-07-25-partner-apps-can-offer-pastoral-care
Church apps can now add the member-owned Pastoral Care experience through the supported v1 API.
*July 25, 2026*
[Back to changelog](/changelog/index)
Third-party church apps can now offer the same member-owned Pastoral Care
experience used in TheFaithApp mobile.
## What Members Can Do
Partner apps can let a signed-in member:
* Share, review, edit, and withdraw a confidential care request.
* Choose care-team or pastoral-only visibility.
* Choose urgency and a preferred contact method.
* Review safe status, follow-up, visit, support-plan, and timeline information.
* Manage consent-based follow-up preferences.
* Save, pause, edit, or remove private life-moment dates.
* Create and manage quiet days during sensitive seasons.
## Built Around the Member Boundary
The public API returns only records owned by the signed-in member and their
church. Staff notes, tasks, resolution notes, Care Radar review, availability,
coverage, rite runsheets, preaching plans, and internal coordination remain
inside the protected staff product.
Urgent and crisis requests still require the member to acknowledge that
Pastoral Care is not an emergency service. Counseling, benevolence, and crisis
requests remain restricted to pastoral staff.
## Developer Resources
The new [Pastoral Care integration guide](/api-reference/pastoral-care)
explains authentication, screen flow, privacy boundaries, error handling, safe
data practices, and all 12 published operations. Each operation also has a
generated API reference page with request and response schemas.
# Pastoral Care adds consent-first review signals
Source: https://docs.thefaithapp.com/changelog/2026-07-25-pastoral-care-adds-consent-first-review-signals
Care teams can review supported follow-up signals without automatically labeling or contacting members.
# Pastoral Care adds consent-first review signals
*July 25, 2026*
[Back to changelog](/changelog/index)
Pastoral Care now gives authorized care teams a consent-first place to review
supported situations that may need human attention.
## Church and Member Control
Care Radar is off by default. Eligible church administrators choose whether to
enable it and set review thresholds for unowned care cases, overdue follow-ups,
and active-case capacity.
Members separately choose whether their recorded Community Group absences may
appear for review. That participation source stays off unless the member
enables both Care Radar and group participation follow-up.
## Human Review, Not Automatic Action
Authorized staff can acknowledge or dismiss a visible signal and add a minimum
encrypted note when useful. A signal never diagnoses or labels a member, sends
a message, or opens a care case automatically.
The Care Radar view also shows which potential sources are not ready. General
service attendance, guest continuity, household drift, serving
disengagement, keyword inference, and weighted caregiver scoring remain
deferred until their source data and safeguarding boundaries are reliable.
# Pastoral Care organizes rites, coverage, and preaching
Source: https://docs.thefaithapp.com/changelog/2026-07-25-pastoral-care-organizes-rites-coverage-and-preaching
Care teams can coordinate rite checklists, bounded caregiver handoffs, and dependable preaching plans.
# Pastoral Care organizes rites, coverage, and preaching
*July 25, 2026*
[Back to changelog](/changelog/index)
Pastoral Care now gives authorized staff focused sidebar workspaces for funeral
and wedding details, caregiver absences, and preaching plans. Each workspace
opens directly from the `Pastoral Care` submenu under `Church Management`, so
staff do not need to switch between unrelated tools on one page.
## Rite Runsheets
Staff can start a funeral or wedding runsheet from an existing confidential
care case. A practical checklist covers family communication, participants,
service details, venue, documents, music, and logistics. Private family and
coordination details remain encrypted.
## Bounded Caregiver Coverage
Coverage Mode snapshots a caregiver's active cases for a defined absence.
Covering staff can record minimum next actions and review activity during the
window. When coverage ends, open work is handed back for re-entry review.
## Dependable Preaching History
The preaching calendar records the actual scheduled date, speaker, audience,
service, series, Scripture, and important liturgical or civil moments. Plans
marked delivered build a reviewed Scripture ledger from launch forward rather
than treating old upload dates as preached dates.
Successor dossiers, personal-story storage, historical sermon import, and
specialized or anonymous care workflows remain deferred until their own
governance and safeguarding rules are ready.
# Discipleship turns classes into formation pathways
Source: https://docs.thefaithapp.com/changelog/2026-07-27-discipleship-turns-classes-into-formation-pathways
Churches can build formation pathways with lessons, quizzes, teachers, member progress, and verifiable completion certificates.
# Discipleship Turns Classes into Formation Pathways
**Discipleship** is now a top-level TheFaithApp product for church-owned classes
and spiritual formation. Administrators can start blank or use a membership,
baptism, new-believer, or leadership template, then customize every section and
lesson for their church.
Lessons can combine teaching, Scripture, video, audio, downloads, reflection,
group discussion, and acknowledgement prompts. Teachers can add optional or
required quizzes with single-choice, multiple-choice, true-or-false, and
short-answer questions, along with accepted answers, scoring, explanations,
passing thresholds, and attempt limits.
Discipleship managers can assign teachers and reviewers without giving every
staff member full product control. Publishing creates a fixed pathway version,
so a learner keeps the lessons they started while the church prepares a later
update.
Members can discover pathways in the mobile app, enroll in open pathways,
request approval where required, continue lessons, take quizzes, and follow
their progress through completion. Staff can approve requests, add invited
learners, and review or manage enrollment from the pathway learner dashboard.
Churches can also place Discipleship directly in their customized mobile
navigation.
Churches can enable completion certificates and customize their title, award
text, signatory, and accent color. Completing all required lessons issues a
downloadable PDF automatically. Each certificate has a public verification
page, and authorized teachers can revoke a certificate that was issued in
error.
A unified formation-history view, mentorship, goals, and private class journals
remain future work.
Read the [Discipleship product guide](/product/discipleship) to set up
permissions, build a pathway, configure quizzes, assign teachers, publish a
version, and understand the member experience.
# Discipleship connects mentors and members
Source: https://docs.thefaithapp.com/changelog/2026-07-28-discipleship-connects-mentors-and-members
Churches can shape staff-led mentorship programs, pair members with mentors, and keep shared check-ins in one protected journey.
# Discipleship connects mentors and members
Discipleship now supports a complete staff-led mentorship journey alongside
classes and pathways. Churches can shape the program, pair an existing member
with a permissioned staff mentor, and keep their conversations and next steps
connected over time.
## Mentorship that fits the church
Admins and teachers can create mentorship programs with a church-specific
name, description, duration, meeting rhythm, and check-in prompt. They can
also decide whether members may add their own shared check-ins.
Discipleship managers assign members to staff who already have an appropriate
Discipleship permission. Assigned teachers see their own pairings, while
managers retain a church-wide view.
## One shared journey
Mentors can add conversation summaries and next steps, manage the pairing's
active or paused state, and mark the journey complete. Check-in content is
encrypted when stored.
Members can open **Mentorship** from the mobile Discipleship screen to see
their mentor, program rhythm, and shared timeline. When member contributions
are enabled, the member can add a check-in after seeing clearly that it will
be visible to the mentor.
Shared check-ins do not replace a private journal. Personal goals and private
class journals remain separate future work.
Read the [Discipleship product guide](/product/discipleship) to create a
program and pair mentors with members.
# Discipleship remembers every formation step
Source: https://docs.thefaithapp.com/changelog/2026-07-28-discipleship-remembers-every-formation-step
Members and church teams can review pathway history, preserve certificates, and begin new formation cycles without losing earlier progress.
# Discipleship remembers every formation step
Discipleship now keeps a lasting formation history when a member completes or
repeats a pathway. Earlier progress, curriculum versions, completion dates,
and certificates remain available instead of being replaced by the newest
enrollment.
## One timeline across pathways
Church teams can open **Formation History** to review enrollment cycles across
membership, baptism, new-believer, serving, leadership, and custom pathways.
They can search and filter the timeline, inspect the exact pathway version used
for each cycle, and open its certificate record.
Members have their own Formation History in the mobile app, with a concise
summary and a cycle-by-cycle view of progress and certificates.
## Repeat pathways with church-defined rules
Admins and assigned teachers can decide whether members may repeat a pathway
and set a waiting period after completion. Open pathways can begin immediately
when eligible, approval-based pathways return to staff review, and invite-only
pathways remain teacher-controlled.
Authorized staff can also start a fresh cycle from Formation History when a
member needs help. The new cycle uses the current published curriculum while
the member's earlier record remains unchanged.
The pathway library also includes a new church-editable **Serving
foundations** starting point.
Read the [Discipleship product guide](/product/discipleship) to configure repeat
rules and review formation history.
# Gifts find open serving needs
Source: https://docs.thefaithapp.com/changelog/2026-07-28-gifts-find-open-serving-needs
Churches can shape discernment instruments that keep member results private, invite trusted mentor affirmation, and connect strong gifts to real opportunities.
# Gifts find open serving needs
Discipleship now helps a church move from reflection to a real serving next
step without treating a score as a permanent label or exposing private member
answers to instrument authors.
## Shaped by each church
Admins and teachers can customize the introduction, response scale, gift or
temperament areas, questions, weights, serving-skill links, and dormant-gift
timing. Publishing creates a fixed version, so later edits do not rewrite an
earlier member result.
Volunteer opportunity editors can now assign the serving skills each open need
uses. Member recommendations include only active, available opportunities and
name the gift that explains each match.
## Private first, shared by choice
Answers and results are encrypted and private to the member. A member may
choose an active assigned staff mentor to see one result. Only that mentor can
open it and add a shared affirmation, and the member can revoke access later.
## From pattern to practice
Members can join an opportunity or request approval directly from the result.
If a strong gift has not found a serving rhythm after the church's chosen
period, the app gently resurfaces it for another look or a mentor conversation.
Read the [Discipleship product guide](/product/discipleship) to connect gift
areas, serving skills, and open opportunities.
# Personal formation stays personal
Source: https://docs.thefaithapp.com/changelog/2026-07-28-personal-formation-stays-private
Members can follow private discipleship goals and keep encrypted class reflections while churches provide customizable starting points without reading private progress.
# Personal formation stays personal
Members now have a private place for personal discipleship goals and class
reflections. Churches can offer thoughtful starting points without turning
personal formation into a staff-monitoring dashboard.
## Church-shaped starting points
Admins and teachers can create goal templates for prayer, Scripture,
community, service, rest, generosity, or another formation area. Each template
can include a suggested duration and a private progress prompt.
Members decide whether to use a template. They can rename and personalize it
or create a goal of their own. Goal wording, progress, and reflections are not
shown to staff.
## Private progress and reflection
In the mobile app, members can record private goal check-ins, pause or resume
a goal, and mark it complete. They can also keep an encrypted general journal
entry or link a reflection to one of their own class cycles.
Only the member can read, edit, or permanently delete these entries. Private
goal and journal content is separate from the shared check-ins used in a
mentor/mentee pairing.
Cohort-linked journals remain unavailable until a dedicated Discipleship
cohort workflow exists.
Read the [Discipleship product guide](/product/discipleship) to create goal
starting points and understand the privacy boundary.
# Seasonal Rules of Life stay private
Source: https://docs.thefaithapp.com/changelog/2026-07-28-seasonal-rules-of-life-stay-private
Churches can shape prayerful seasonal rhythms while every member writes and revisits a private covenant without streaks or scores.
# Seasonal Rules of Life stay private
Discipleship now helps churches invite members into a prayerful rhythm for a
season without turning formation into another performance tracker.
## A shape the church can make its own
Admins and teachers can create a season with its own name and dates, opening
invitation, covenant prompt, closing reflection, and practice guidance.
Prayer, rest, work, and generosity remain represented, while churches can
rename practices, make them optional, and add practices for their own context.
## A covenant the member owns
Members begin with the church's invitation, then write their own covenant and
commitment for each practice. They can save a draft, covenant it when ready,
revise it during the season, and close it with a private reflection.
Those words are encrypted and visible only to the member. Staff see the
reusable template, not who started it or what anyone wrote.
## Grace instead of streaks
Rule of Life follows church seasons, not daily completion counts. A new season
starts as a fresh invitation, with no score or streak carried forward.
Read the [Discipleship product guide](/product/discipleship) to create a
seasonal Rule of Life.
# Changelog
Source: https://docs.thefaithapp.com/changelog/index
Product updates, improvements, and releases across TheFaithApp.
Follow the latest product updates across TheFaithApp. Each entry highlights what changed, why it matters, and where the update shows up in the platform.
## Latest Updates
**July 28, 2026**
Members can gently revisit explicit goals and Rule of Life commitments while churches shape the invitation without seeing personal activity.
**July 28, 2026**
Churches can shape Sabbath and retreat invitations while members privately mute church broadcasts for a chosen window.
**July 28, 2026**
Churches can shape every season of the year, and members automatically receive the current tone, Scripture, and practices without being scored.
**July 28, 2026**
Churches can shape biblical lament liturgies while private words stay off the server and optional wall offerings remain moderated and anonymous.
**July 28, 2026**
Churches can coordinate shared fasts with meaningful substitutions while members join without explaining their health or circumstances.
**July 28, 2026**
Churches can shape a gentle evening review while members know their encrypted private words will be permanently deleted on schedule.
**July 28, 2026**
Churches can publish their own fixed-hour liturgies while members choose gentle local bells, pray offline, and sense anonymous live presence.
**July 28, 2026**
Churches can shape prayerful seasonal rhythms while every member writes and revisits a private covenant without streaks or scores.
**July 28, 2026**
Churches can shape discernment instruments that keep member results private, invite trusted mentor affirmation, and connect strong gifts to real opportunities.
**July 28, 2026**
Members can follow private discipleship goals and keep encrypted class reflections while churches provide customizable starting points without reading private progress.
**July 28, 2026**
Churches can shape staff-led mentorship programs, pair members with mentors, and keep shared check-ins in one protected journey.
**July 28, 2026**
Members and church teams can review pathway history, preserve certificates, and begin new formation cycles without losing earlier progress.
**July 27, 2026**
Churches can build customizable classes with lessons, quizzes, teachers, member progress, and verifiable completion certificates.
**July 25, 2026**
Developers can add authenticated general and campaign giving without placing payment-processing endpoints or provider secrets in their apps.
**July 25, 2026**
Church apps can add member-owned care requests, private follow-up preferences, life moments, and quiet days through the v1 API.
**July 25, 2026**
Care teams can coordinate rite checklists, bounded caregiver handoffs, and dependable preaching plans.
**July 23, 2026**
Microphones and cameras now stay off after a member leaves and returns to the app foreground.
**July 23, 2026**
Video-room members can reduce video data while keeping prayer audio, chat, and room controls available.
**July 23, 2026**
Members can share an encrypted prayer request with a smaller, permission-controlled pastoral team.
**July 23, 2026**
Members can privately ask leaders for timely prayer support while churches coordinate a safe, owned response.
**July 23, 2026**
Churches can organize verified prayer volunteers around safe daily lists, assignments, availability, and weekly email digests.
**July 23, 2026**
Members can keep prayers private, record answered reflections, share when ready, and choose daily, weekly, or one-time reminders.
**July 23, 2026**
Members can share prayer requests with their church, a Community Group, or church leaders and retain control through editing and withdrawal.
**July 23, 2026**
Churches can connect Handwrytten and send consent-aware welcome cards from a visitor journey, with guarded sender setup, test or live review, and order tracking.
**July 21, 2026**
Churches can build, publish, share, and embed flexible forms, then assign and complete every response from one organized inbox.
**July 18, 2026**
Developers can add hosted member sign-in to React Native and Expo apps without running a callback website.
**July 18, 2026**
Developers can register a Flutter app in Developer Access and use the new SDK to receive a member bearer token without hosting a callback website.
**July 17, 2026**
Members can use clearer employment help, a reviewed lending and medical-equipment library, synchronized ministry chats, and flexible quiet hours and push preferences.
**July 17, 2026**
Members can privately share interest in future community-support ideas while staff see only protected aggregate readiness.
**July 17, 2026**
Staff can connect a reviewed Needs & Offers donation drive to an existing campaign, giving members one coordinated place to contribute.
**July 16, 2026**
Members can return to their groups, discover new ones, and open linked discussions or announcements from one mobile Community experience.
**July 16, 2026**
Guests can plan a visit or connect without an account while staff coordinate consent-aware follow-up, useful next steps, and optional physical welcome cards.
**July 14, 2026**
See personal commitments, useful next steps, group updates, saved sermon moments, and quick actions together on the mobile Home screen.
**June 27, 2026**
Members can browse a privacy-first church directory, control what they share, and staff can manage households, approvals, and reminders.
**June 22, 2026**
Trial Prayer Rooms now default to smaller gatherings with monthly participant-minute metering before upgrading.
**June 19, 2026**
External apps can now use TheFaithApp-hosted member sign-in instead of bringing their own Firebase credentials.
**June 17, 2026**
Members can now share approved prayer requests, mark that they prayed, and follow up when prayers are answered.
**June 17, 2026**
Members can now create and join beta audio and video prayer rooms, use room controls, and give toward room goals.
**June 13, 2026**
Chat now supports richer image, PDF, voice note, and sermon attachment experiences across web and mobile.
**June 12, 2026**
Chat now has better room lists, timeline grouping, search, presence, reply navigation, and group details.
**June 11, 2026**
Admins can now manage room behavior with moderation, read states, mentions, reactions, and notification preferences.
**June 11, 2026**
Third-party apps can now read published sermon transcripts, chapters, insights, and translated transcript cues.
**June 10, 2026**
Chat messages, typing states, and room updates now arrive faster across web and mobile.
**June 9, 2026**
Generate reviewed sermon transcripts, chapters, insights, translations, quote cards, content drafts, and uploaded-video clips.
**May 29, 2026**
The app customization workspace is now open to all admins, without the earlier rollout gate.
**May 15, 2026**
Design a branded mobile experience with your own theme, navigation, custom pages, reusable content blocks, live preview, and release controls.
# Getting Started
Source: https://docs.thefaithapp.com/index
Product guides and API reference for TheFaithApp.
# TheFaithApp Documentation
Welcome to the unified documentation for TheFaithApp.
This workspace now combines:
* Product documentation for admins, church operators, and internal teams
* API documentation for mobile apps, partner apps, and other integrations
* Release notes and documentation updates
## Start Here
* Read [Authentication](/product/authentication) for the first admin login and account access flows
* Continue with [Dashboard and Internal Tools](/product/dashboard-and-internal-tools) for the everyday admin workspace
* Open [Forms](/product/forms) to build, publish, share, and embed church forms and manage response follow-up
* Use [Content Management](/product/content-management) for sermons, devotionals, public devotional pages, bulletins, categories, and streaming workflows
* Open [Church Operations](/product/church-operations) for members, branches, gatherings, and admin access management
* Open [Events and Volunteers](/product/events-and-volunteers) for events, registration setup, ministries, volunteer skills, and signup review
* Open [Giving and Finance](/product/giving-and-finance) for donations, recurring gifts, funds, public giving pages, payment providers, billing plans, and AI add-on billing
* Open [Outreach and Donor Management](/product/outreach-and-donor-management) for campaigns, donors, donor forms, campaign analytics, public campaign pages, and donor profile pages
* Open [Engagement and Communication](/product/engagement-and-communication) for prayer requests, notifications, chats, invitations, and member saved-item features
* Open [Marketing](/product/marketing) for Mailgun, Twilio, campaigns, templates, subscriber lists, and marketing dashboards
* Open [Analytics](/product/analytics) for engagement, content, demographics, cohorts, notification performance, app versions, custom metrics, and alerts
* Open [Settings, Branding, and App Customization](/product/settings-branding-and-customization) for church profile, socials, email, Firebase setup, white-label branding, domains, page branding, and mobile app design workflows
* Open [API Introduction](/api-reference/introduction) to start with the public `v1` API
* Track documentation changes in [Changelog](/changelog)
## Documentation Structure
### Getting Started
Use this section for onboarding flows, shared concepts, and platform orientation.
### Product Guides
Use these pages for real admin workflows in the dashboard, with steps, screenshots, prerequisites, and caveats.
### API Reference
Use the API reference when integrating with TheFaith mobile, third-party apps, or custom church experiences.
### Changelog
Use the changelog to track product-facing documentation updates and notable platform releases.
# Admin Navigation
Source: https://docs.thefaithapp.com/product/admin-navigation
Move between the six TheFaithApp admin products and their feature menus.
# Admin Navigation
The admin sidebar is organized around six products:
* `Church Management`
* `Analytics`
* `Marketing`
* `Outreach Campaigns`
* `Forms`
* `App Customization`
## Open a Product
1. Go to `/home`, or click the TheFaithApp logo, to see the six products.
2. Select the product you want to use.
3. Choose a feature from that product's menu.
Selecting a product replaces the product list with its feature menu. This keeps unrelated tools out of the way while you work.
## Return to the Product List
Use the back arrow beside the product name at the top of the sidebar. Your current page stays open while the sidebar returns to the six-product list.
## Work With Nested Menus
Some features contain another level of options. For example, `Marketing` contains `Email Marketing` and `SMS Marketing`, while `Outreach Campaigns` contains `Donor Management`.
1. Select the feature with the right arrow.
2. Choose the page you need.
3. Use the back arrow to return one level at a time.
## Church Management Dashboard
The Church Management dashboard is available at `/church`. Open `Church Management`, then select `Dashboard`.
The `/home` page is reserved for choosing among the six products.
## Forms
Admins with the `Manage Forms` permission can open `Forms`, then select
`All Forms` to view or create form drafts. `Donor Forms` remains under
`Outreach Campaigns` and is a separate workflow.
Read the [Forms guide](/product/forms) for creating, publishing, sharing, and
managing responses.
## Direct Links and Refreshing
When you open or refresh a feature URL, the sidebar opens the matching product and feature menu automatically. This lets bookmarked pages retain their navigation context.
## Notes
* Product search is no longer shown in the header because all products are available in the sidebar.
* Menu items can vary with your admin permissions.
* On smaller screens, open the menu from the header and follow the same product and feature structure.
# Analytics
Source: https://docs.thefaithapp.com/product/analytics
Review engagement, content activity, demographics, cohorts, notifications, app versions, and alert-driven analytics workflows in TheFaithApp.
# Analytics
This guide covers the analytics workspace used to understand engagement, audience trends, app adoption, and alert-based monitoring in TheFaithApp.
These tools include:
* Analytics dashboard
* Engagement analytics
* Content analytics
* Demographics analytics
* Cohort analysis
* Notification analytics
* App version analytics
* Custom metrics
* Analytics alerts
## Before You Start
* Sign in to your admin account.
* Open `Analytics` from the six-product sidebar, then choose the analytics page you need.
* Use the date range and platform filters when you want to narrow the results.
* Some analytics areas may show limited or empty data until your app has enough tracked usage.
## Analytics Dashboard
Use the main dashboard when you want one place to review sessions, users, engagement trends, and content performance.
![Analytics dashboard overview]()
### What You Can Do
* Review session and user totals
* Check content views and media plays
* Compare current activity to the previous period
* Review engagement charts
* See platform distribution
### Steps
1. Open `Analytics`.
2. Stay on `Dashboard`.
3. Review the top cards first.
4. Use the date range and platform filters when you need a narrower view.
5. Click `Refresh` if you want to reload the latest totals.
### Notes
* The dashboard is the best first stop for day-to-day performance review.
* `Overview`, `Engagement`, and `Content` are tabs inside the main analytics dashboard, not separate left-nav pages.
## Engagement Analytics
Use the `Engagement` tab when you want to focus on sessions, new users, session duration, bounce rate, and device activity.
![Analytics dashboard engagement tab]()
### What You Can Do
* Review total sessions
* Review new users
* Check average session duration
* Monitor bounce rate
* Compare activity by device
### Steps
1. Open `Analytics`.
2. Click the `Engagement` tab.
3. Review the top engagement cards.
4. Use the chart and device panel to understand how people are using the app.
### Notes
* This view is useful when you want to understand usage quality, not just raw traffic.
## Content Analytics
Use the `Content` tab when you want to review how sermons, media, and other content are performing.
![Analytics dashboard content tab]()
### What You Can Do
* Review total content views
* Review media plays
* See how many content types are active
* Review top-performing content
* Check whether content activity is available for the selected date range
### Steps
1. Open `Analytics`.
2. Click the `Content` tab.
3. Review the top content cards.
4. Use the content breakdown and top-performing content panels to understand what people are consuming.
### Notes
* Empty content panels usually mean the selected period has little or no tracked content activity yet.
## Demographics Analytics
Use demographics analytics when you want to understand the makeup of your audience and how complete your user profile data is.
![Demographics analytics]()
### What You Can Do
* Review total users and sessions
* Check age, gender, and location data coverage
* Review age group distribution
* Review gender distribution
* Review top countries, regions, and cities
### Steps
1. Open `Analytics`.
2. Click `Demographics`.
3. Review the summary cards at the top.
4. Scroll down to the age, gender, and location sections.
5. Use the date range or platform filters if you want a narrower audience view.
### Notes
* Coverage percentages show how much demographic data is actually available in the current user base.
* Empty demographic sections usually mean those user profile fields have not been collected consistently yet.
## Cohort Analysis
Use cohorts when you want to understand retention, churn, and how groups of users behave over time.
![Cohort analysis]()
### What You Can Do
* Review total cohorts and total users
* Check average retention
* Review churn rate
* Compare active and churned users
* Inspect the cohort retention matrix
* Review churn by cohort period
### Steps
1. Open `Analytics`.
2. Click `Cohorts`.
3. Choose the period and number of months you want to analyze.
4. Review the overview cards first.
5. Use the retention matrix and churn table to study longer-term user behavior.
### Notes
* Cohorts are especially useful when your team wants to understand how well new users stay engaged after joining.
## Notification Analytics
Use notification analytics when you want to measure delivery and engagement for push notifications.
![Notification analytics]()
### What You Can Do
* Review total notifications sent
* Review delivered, opened, and clicked totals
* Check delivery, open, and click rates
* Review daily notification activity
* Compare notification activity by platform
* Review top-performing notifications
### Steps
1. Open `Analytics`.
2. Click `Notifications`.
3. Review the delivery and engagement cards at the top.
4. Scroll to the chart, platform split, and top notification sections.
5. Use the filters if you want to isolate one platform or period.
### Notes
* This page is useful for judging both technical delivery and audience response.
* Empty notification sections usually mean there has not been enough notification activity in the selected period.
## App Version Analytics
Use app version analytics when you want to track adoption of newer app releases and spot version-based performance differences.
![App version analytics]()
### What You Can Do
* Review the latest app version in use
* Check the adoption rate for the latest release
* Compare users across app versions
* Review adoption trends over time
* Compare version performance
* Review latest-version recommendations
### Steps
1. Open `Analytics`.
2. Click `App Versions`.
3. Review the top adoption cards.
4. Use the version distribution and adoption trend sections to see how upgrades are spreading.
5. Review the performance comparison table for version-specific differences.
### Notes
* This view is especially helpful when you are encouraging users to upgrade to a newer app release.
## Alerts And Metrics
Use the reports area when you want to manage backend-driven custom metrics and analytics alerts.
![Reports custom metrics tab]()
### What You Can Do
* Create custom metrics
* Review whether custom metrics are active
* Create analytics alerts
* Review alert totals, active alerts, and alerts triggered today
### Steps
1. Open `Analytics`.
2. Click `Reports`.
3. Stay on `Custom Metrics` when you want to manage saved metric definitions.
4. Open `Alerts` when you want to manage threshold-based alerts.
5. Click `Refresh` when you want to reload the latest configuration state.
### Notes
* This page currently focuses on custom metrics and alerts.
* The reports workspace is useful for teams that want more tailored monitoring than the default dashboard cards provide.
## Custom Metrics
Use custom metrics when your team wants to define a KPI that is more specific to your ministry or organization.
![Create custom metric drawer]()
### What You Can Do
* Name a custom metric
* Add a description
* Choose the metric type
* Choose the data source
* Choose the chart type
* Turn the metric on or off
### Steps
1. Open `Analytics`.
2. Click `Reports`.
3. Stay on `Custom Metrics`.
4. Click `Create Metric`.
5. Complete the metric details and save it.
### Notes
* Custom metrics are useful when standard dashboard totals do not answer a recurring business question.
## Analytics Alerts
Use alerts when you want TheFaithApp to flag important changes in your analytics thresholds.
![Reports alerts tab]()
### What You Can Do
* Review total and active alerts
* See how many alerts triggered today
* Create a new alert
* Activate or deactivate alerts after they exist
* Test alerts after setup
### Steps
1. Open `Analytics`.
2. Click `Reports`.
3. Open the `Alerts` tab.
4. Review the alert summary cards.
5. Click `Create Alert` when you want to add a new threshold rule.
### Notes
* Alerts are best for ongoing monitoring rather than one-time reporting.
## Creating An Alert
Use the alert drawer when you want to define the metric, threshold, and recipient list for analytics monitoring.
![Create analytics alert drawer]()
### What You Can Do
* Name the alert
* Add a short description
* Choose the metric to monitor
* Choose the condition
* Set the threshold value
* Set the period
* Add recipient email addresses
### Steps
1. Open `Analytics`.
2. Click `Reports`.
3. Open the `Alerts` tab.
4. Click `Create Alert`.
5. Fill in the metric, condition, threshold, and recipients.
6. Save the alert.
### Notes
* Recipient emails determine who receives the alert notification.
## Current Product Notes
* `Engagement` and `Content` analytics are part of the main dashboard tabs rather than separate left-nav pages.
* The current analytics web workspace exposes custom metrics and alerts, but it does not currently expose a separate scheduled reports screen in the admin UI we reviewed.
* Analytics tracking endpoints support app and integration data collection, but they belong in the API reference rather than the non-technical product guide.
# Authentication
Source: https://docs.thefaithapp.com/product/authentication
Sign in, sign up, password reset, email verification, and two-factor authentication for TheFaithApp admins.
# Authentication
This guide explains how admins access TheFaithApp and recover access when needed.
The auth experience includes:
* Sign in
* Sign up
* Forgot password
* Reset password
* Email verification
* Two-factor authentication challenge
## Sign In
Admins sign in with their email address and password from the sign-in page.
### Steps
1. Open `/sign-in`.
2. Enter the admin email address.
3. Enter the password.
4. Click `Sign In`.
![Sign in screen]()
### Current Behavior
* A successful sign-in opens the dashboard home page.
* If two-factor authentication is enabled, the user is asked to complete a verification step before access is granted.
* If the account email has not yet been verified, the user is taken to the email verification screen.
### Notes
* The sign-in page includes a direct link to `Forgot password`.
* The UI also links new users to `Sign up`.
## Sign Up
New churches can create an account from `/sign-up`.
### Steps
1. Open `/sign-up`.
2. Complete the `Personal Info` step.
3. Complete the `Church Info` step.
4. Upload or configure the logo step.
5. Submit the account creation form.
### Collected Information
* User name
* Email
* Password
* Password confirmation
* Church name
* Church location
* Church email
* Church website
* Church logo path
### Result
* On success, the app shows a confirmation toast.
* The user is redirected back to `/sign-in`.
![Sign up screen]()
## Forgot Password
Admins who cannot access their password can start recovery from `/forgot-password`.
### Steps
1. Open `/forgot-password`.
2. Enter the account email address.
3. Submit the form.
### Result
* The app sends a password reset email.
* A success notification confirms the email was sent.
![Forgot password screen]()
### Caveat
* The current page copy mentions a verification code, but the implemented flow sends a password reset email.
## Reset Password
The reset password page opens from the link sent in the password reset email.
### Expected Flow
1. Open the reset link from the email.
2. Enter a new password.
3. Confirm the new password.
4. Submit the form.
### Result
* A valid reset completes the password update.
* The app redirects the user back to `/sign-in` after a short delay.
### Caveats
* If the reset link is incomplete or expired, the page asks the user to request a new password reset email.
## Email Verification
If an admin account is not verified after sign-in, the app takes the user to the email verification screen.
### Available Actions
* Resend verification email
* Confirm that verification has already been completed
* Sign out
### Behavior
* If verification is completed from the email link, the page can continue the login flow automatically.
* After verification, the app returns the user to the main signed-in experience.
## Two-Factor Authentication
The app supports a second verification step for accounts that have two-factor authentication enabled.
### Supported Challenge Methods
* Authenticator code
* Recovery code
### Behavior
* If the user leaves the flow before completing verification, they need to sign in again.
* On success, the user continues into the dashboard.
# Church Operations
Source: https://docs.thefaithapp.com/product/church-operations
Manage members, imports, branches, gatherings, admin accounts, roles, and permissions in TheFaithApp.
# Church Operations
This guide covers the main church administration tools used to manage people, locations, schedules, and internal access.
These tools include:
* Members
* Member imports
* Import history and undo
* Branches
* Gatherings
* Admin accounts
* Roles and permissions
## Before You Start
* Sign in to your admin account.
* `Members`, `Branches`, `Gatherings`, and `Admins` are in the left sidebar.
* Some account-management actions depend on your own admin level.
## Members
Use Members to manage your church member directory and review engagement status.
![Members screen]()
### What You Can Do
* Review total, active, inactive, and new member counts
* Search the directory
* Filter by gender and activity status
* Open a member profile to see more details
* Resend an invite to members who have not logged in yet
### Steps
1. Click `Members` in the left sidebar.
2. Use the search field to find a member by name or email.
3. Use the gender and status filters when needed.
4. Click the view icon to open the member details drawer.
5. Use the resend invite action for members who still need access.
### Notes
* Member status is based on recent login activity.
* The view drawer shows contact, personal, location, and account details.
## Member Imports
Use the import flow when you need to add many members at once from a CSV file.
![Member import drawer]()
### What You Can Do
* Upload a CSV file
* Confirm whether the first row contains headers
* Download a sample template
* Map CSV columns before processing the import
### CSV Requirements
* File type must be CSV
* Required columns are `Name` and `Email`
* Optional columns include `Phone` and `Gender`
### Steps
1. Open `Members`.
2. Click `Import Members`.
3. Upload the CSV file.
4. Confirm whether the first row contains column headers.
5. Continue to the mapping step.
6. Match each required field to the correct CSV column.
7. Review the sample data preview.
8. Start the import.
### Result
* The system processes the file and shows imported, skipped, and failed totals.
## Import History And Undo
Use Import History to review past member uploads and undo a completed import if needed.
![Import history drawer]()
### What You Can Do
* Review past imports
* See totals for imported, skipped, and failed rows
* Undo a completed import that created members
### Steps
1. Open `Members`.
2. Click `Import History`.
3. Review the import status and totals.
4. Click `Undo` on a completed import if you need to reverse it.
5. Confirm the undo action.
### Notes
* Undo is only available for completed imports that successfully created members.
* The member directory refreshes after an undo is completed.
## Branches
Use Branches to manage church campuses or locations.
![Branches screen]()
![Create branch drawer]()
### What You Can Do
* Create a branch
* Search branches
* Edit branch details
* Delete a branch
### Branch Details
* Branch name
* Location
* Pastor
* Contact
### Steps
1. Click `Branches` in the left sidebar.
2. Click `Add Branch`.
3. Enter the branch details.
4. Save the branch.
5. Use the edit or delete actions from the list when updates are needed.
### Notes
* If no branches exist yet, the page shows an empty state with a direct `Add Branch` action.
## Gatherings
Use Gatherings to manage recurring church services and meetings.
![Gatherings screen]()
### What You Can Do
* Create a new gathering
* Search gatherings
* Filter by type or day
* Edit or delete a gathering
* Turn gatherings on or off with the active toggle
* View the list of available gathering types
### Gathering Details
* Gathering type
* Gathering name
* Day of the week
* Start time
* End time
* Description
* Active status
### Steps
1. Click `Gatherings`.
2. Click `Add Gathering`.
3. Choose the gathering type.
4. Enter the name, day, and time range.
5. Add an optional description.
6. Save the gathering.
7. Use the active toggle when you want to temporarily hide or reopen a regular gathering.
## Roles And Permissions
Use Roles and Permissions to control what each internal team role can access.
![Role permissions drawer]()
### What You Can Do
* Create a new role
* Edit an existing role
* Assign permissions by category
* Select all permissions in one category
* Select all or clear all permissions across the whole role
### Permission Areas
* Content management
* Events and activities
* Communication
* Community
* Chat
* Media and finance
* Marketing
* Administration
### Steps
1. Click `Admins` in the left sidebar.
2. In `Roles & Permissions`, click `Create role`.
3. Enter the role name.
4. Select the permissions the role should have.
5. Save the role.
### Notes
* Roles are used when assigning or updating admin accounts.
* Existing roles can be opened again to adjust permissions later.
## Admin Accounts
Use Admins to manage internal staff and assign them to the right role.
![Admins screen]()
### What You Can Do
* Add a new admin account
* Search admin accounts
* Filter by role or group
* Change an admin’s assigned role
* Edit account details
* Delete an admin account when allowed
### Steps
1. Click `Admins`.
2. Click `Add Admin`.
3. Enter the admin name, email address, role, and password.
4. Save the account.
5. Use the group dropdown in the table when you want to reassign a role quickly.
6. Use the edit action for account updates.
### Notes
* The roles section sits above the accounts table on the same page.
* Some group changes or delete actions may be limited to higher-level admins.
# Content Management
Source: https://docs.thefaithapp.com/product/content-management
Organize categories, manage sermons, publish devotionals and bulletins, and configure streaming in TheFaithApp.
# Content Management
This guide covers the main tools used to organize and publish church content in TheFaithApp.
These tools include:
* Categories
* Media library
* Audio sermons
* Video sermons
* Sermon AI tools
* YouTube in app
* Devotionals
* Digital bulletins
* Streaming
## Before You Start
* Sign in to your admin account.
* `Categories`, `Sermons`, `Devotionals`, `Bulletins`, and `Streaming` are in the left sidebar.
* Some actions, such as editing or deleting content, depend on your admin permissions.
## Categories
Use Categories to group sermons and keep content organized.
![Categories screen]()
### What You Can Do
* Create a new category
* Add an optional category image
* Search existing categories
* Edit a category name or image
* Open a category to manage its media
* Delete a category you no longer need
### Steps
1. Click `Categories` in the left sidebar.
2. Click `Add new`.
3. Enter the category name.
4. Upload a category image if you want one.
5. Save the category.
### Tips
* Use clear category names so members can find sermons more easily in the app.
* Open a category when you want to manage the audio and video content assigned to it.
## Media Library By Category
Each category has its own media library where you can switch between audio and video items.
![Category media library]()
### Steps
1. Open `Categories`.
2. Click the view icon on a category card.
3. Use the `Audios` and `Videos` tabs to switch content types.
4. Click `Add Media` to add a new item directly inside that category.
### What You Can Do Here
* Keep related audio and video sermons together
* Search within the category
* Preview audio or play video content
* Edit or delete media from the same screen
## Audio Sermons
Use Audio Sermons to publish sermon recordings and other audio messages.
![Audio sermons screen]()
### What You Can Do
* Add a new audio sermon
* Upload an audio file or use an audio link
* Assign the sermon to a category
* Add a cover photo, title, description, and duration
* Preview audio from the list
* Edit or delete existing audio sermons
### Steps
1. Open `Sermons` in the left sidebar.
2. Select `Audios`.
3. Click `Add new`.
4. Choose the category.
5. Add the title, description, and duration.
6. Upload the audio file or add the audio link.
7. Upload a cover photo.
8. Save the sermon.
## Video Sermons
Use Video Sermons to manage uploaded and linked sermon videos.
![Video sermons screen]()
### What You Can Do
* Add a new video sermon
* Assign the video to a category
* Add a cover photo, title, description, and duration
* Preview videos from the list
* Edit or delete existing videos
### Supported Video Sources
* Uploaded MP4 files
* Direct MP4 links
* YouTube video IDs
* Vimeo video IDs
* Dailymotion video IDs
* M3U8 and MPD streaming links
* Facebook public video links
### Steps
1. Open `Sermons`.
2. Select `Videos`.
3. Click `Add new`.
4. Choose the category.
5. Enter the title, description, and duration.
6. Choose the video source type.
7. Add the file, link, or video ID.
8. Upload a cover photo.
9. Save the sermon.
## Sermon AI Tools
Sermon AI helps your team turn sermons into readable transcripts, member-friendly study tools, translations, shareable drafts, quote cards, and video clips.
![Sermon AI tools on audio sermons]()
### What You Can Do
* Generate a synced transcript for an uploaded audio sermon.
* Review transcript lines and publish them when they are ready for members.
* Generate sermon chapters from a reviewed transcript.
* Generate sermon insights, including a summary, key points, scripture references, reflection questions, and discussion prompts.
* Translate a reviewed transcript into supported languages.
* Create content drafts for social media, newsletters, bulletins, and short sermon snippets.
* Design and download quote cards from sermon excerpts.
* Suggest and download short clips for uploaded video sermons.
### Availability
* Audio sermon AI tools are available for uploaded audio sermons.
* Video transcript, translation, caption, and clip tools are available for uploaded video sermons.
* Linked or external videos, such as YouTube, Vimeo, Facebook, livestream links, M3U8, and MPD sources, do not show the same AI tools because the app does not own the source file.
* Sermon AI generation is part of the Digital Ministry Assistant add-on. Each church can try one free transcript before activating the add-on.
* Published sermon content stays available to members; the add-on controls staff generation tools, not member access to content that has already been published.
### Generate And Publish A Transcript
Use transcripts first. Chapters, insights, translations, content drafts, quote cards, captions, and clips all work best after the sermon has a reviewed transcript.
![Transcript review drawer]()
1. Open `Sermons`.
2. Select `Audios` for an uploaded audio sermon, or `Videos` for an uploaded video sermon.
3. Click the transcript icon or transcript status for the sermon.
4. Click `Generate transcript`.
5. Wait for the status to move from queued or processing to ready for review.
6. Review the transcript lines and timestamps.
7. Edit any lines that need correction.
8. Click `Save changes`.
9. Click `Publish` when the transcript is ready for members.
### What Members See
After you publish a transcript:
* Audio sermons can show a synced transcript player.
* Members can read along while listening.
* Members can tap transcript lines to jump to that moment.
* Uploaded videos can show synced captions from the published transcript.
* Members only see published transcripts and published translations.
If a transcript is not published, members keep the normal audio or video experience without seeing an empty transcript area.
### Create Chapters
Chapters help members jump to major sections of a sermon.
1. Open an audio sermon with a reviewed transcript.
2. Click the chapters icon.
3. Click `Generate chapters`.
4. Review the chapter titles and start times.
5. Edit titles if needed.
6. Click `Save changes`.
7. Click `Publish` when the chapters are ready.
Published chapters appear in the member sermon experience. Draft chapters remain private to admins.
### Create Sermon Insights
Sermon insights give members and staff a quick way to revisit the message.
1. Open an audio sermon with a reviewed transcript.
2. Click the insights icon.
3. Click `Generate insights`.
4. Review the summary, key points, scripture references, reflection questions, and discussion prompts.
5. Edit the content if needed.
6. Click `Save changes`.
7. Click `Publish` when the insights are ready.
Published insights are visible to members. Draft insights remain private to admins.
### Translate A Transcript
Translations help multilingual churches make sermons more accessible.
1. Open an audio sermon or uploaded video sermon with a reviewed transcript.
2. Click the language icon.
3. Choose a language.
4. Click `Translate`.
5. Review the translated transcript lines.
6. Edit any wording that needs correction.
7. Click `Save changes`.
8. Click `Publish` when that language is ready.
Members only see published languages. If a language is still in review, it remains hidden from the member app.
### Create Content Drafts And Quote Cards
Content drafts help staff reuse sermon material without starting from a blank page.
1. Open an audio sermon with a reviewed transcript.
2. Click the repurpose icon.
3. Click `Generate content`.
4. Review the social post, short snippets, newsletter blurb, and bulletin announcement.
5. Edit the text if needed.
6. Click `Save changes`.
7. Copy the draft you want to use.
Quote cards are created from sermon excerpts:
1. Open an audio sermon with a reviewed transcript.
2. Click the quote card icon.
3. Choose a suggested quote or write your own.
4. Pick the style that fits your church brand.
5. Click `Download PNG` to save the card as an image.
Content drafts and quote cards are staff tools. They do not publish directly to members.
### Create Uploaded Video Clips
Uploaded video sermons can use transcripts to suggest short shareable clips.
![Sermon AI tools on video sermons]()
![Video clip drawer]()
1. Open `Sermons`.
2. Select `Videos`.
3. Find an uploaded video sermon.
4. Click the clips icon.
5. Click `Suggest clips`.
6. Review the suggested start and end times.
7. Edit the clip title if needed.
8. Click `Generate` for the clip you want.
9. Click `Download` when the clip is ready.
Clips are generated for staff to download and share. They are not automatically posted anywhere.
### Tips
* Review AI-generated content before publishing it to members.
* Publish the transcript before expecting members to see synced transcript or caption features.
* Use clear chapter titles that describe the sermon section, not only the topic.
* Keep translated transcripts reviewed by someone familiar with the language when possible.
* Regenerating content replaces the current AI draft, so save or copy any edits you want to keep first.
## YouTube In App
Use the YouTube settings drawer to surface a YouTube channel or playlist inside the member app.
![YouTube settings drawer]()
### Steps
1. Open `Sermons` and select `Videos`.
2. Click `YouTube settings`.
3. Add the YouTube channel URL if you want to show the whole channel.
4. Add a playlist if you want to show only selected videos.
5. Turn on `Show YouTube tab in app`.
6. Use `Open preview` if you want to check how it will appear.
7. Click `Save`.
### Result
* Members can see a YouTube tab in the sermons area of the app when this feature is enabled.
## Devotionals
Use Devotionals to publish daily or recurring written reflections for members.
![Devotionals screen]()
### What You Can Do
* Create a new devotional
* Add the devotional date, author, title, and Bible reading
* Write the devotional content
* Add confession, studies, tags, and a thumbnail image
* Set recurring devotionals
* Choose whether to send notifications
* Generate a public devotional link
* Edit or delete devotionals later
### Steps
1. Open `Devotionals`.
2. Click `Add new`.
3. Fill in the devotional details.
4. Upload the thumbnail image.
5. Choose whether the devotional is recurring.
6. Set the notification time if you want to notify members.
7. Save the devotional.
### Public Sharing
* Use `Public Link` on the main page when you want a shareable devotional page or embed code.
## Public Devotional Page
Use the public devotional page when you want members or visitors to browse devotionals outside the admin dashboard.
![Public devotionals page]()
### What Visitors Can Do
* Browse the published devotionals
* Search devotionals from the public page
* Open a devotional to read the full reflection
### Steps
1. Open `Devotionals`.
2. Click `Public Link`.
3. Open the public devotional link.
4. Review the devotional list and use search if needed.
5. Click a devotional card to open it.
### Notes
* The public devotional page is designed for sharing outside the admin dashboard.
* Visitors can browse devotionals directly from the public page.
## Public Devotional Detail Page
Use the devotional detail page when you want to share one specific devotional or let readers open the full message from the public list.
![Public devotional detail page]()
### What Visitors Can Do
* Read the devotional title, date, and author
* Review the devotional image and written reflection
* Use the back link to return to the devotional list
### Steps
1. Open the public devotional page.
2. Click the devotional you want to read.
3. Review the devotional content on the detail page.
4. Use `Back to Devotionals` when you want to return to the list.
### Notes
* Each devotional opens on its own public page, which makes it easier to share a single reflection.
* The public detail page reflects the content saved on the devotional record.
## Digital Bulletins
Use Digital Bulletins to publish church bulletins as either rich content or PDFs.
![Digital bulletins screen]()
### What You Can Do
* Create a bulletin from scratch
* Upload a PDF bulletin
* Search and filter bulletins by status and type
* View bulletin details
* Publish drafts
* Archive published bulletins
* Duplicate a past bulletin
* Resend bulletin notifications
* Edit or delete bulletins
### Steps
1. Open `Bulletins`.
2. Click `Create Bulletin`.
3. Choose whether the bulletin will be `Native` or `PDF`.
4. Enter the bulletin title.
5. Add the content or upload the PDF.
6. Save it as a draft or publish it.
### Bulletin Types
* `Native` bulletins let you build content sections directly in the app.
* `PDF` bulletins let you upload a finished bulletin file.
## Streaming
Use Streaming to manage both radio and live broadcast settings.
### Radio Streaming
![Radio streaming settings]()
### Live Streaming
![Live streaming settings]()
### Program Lineup
![Program lineup screen]()
### What You Can Do
* Configure radio streaming details
* Add or replace the cover image
* Set the stream URL and status
* Configure live stream settings
* Choose the live source type
* Preview radio or live streams before saving
* Build a weekly program lineup with days and times
### Supported Live Sources
* RTMP live stream URLs
* YouTube Live video IDs
* M3U8 URLs
### Basic Steps
1. Open `Streaming`.
2. Use `Radio Streaming` to update the audio stream title, image, URL, and status.
3. Switch to `Live Streaming` to configure the live broadcast source.
4. Open `Program Lineup` to add scheduled shows and their broadcast times.
5. Preview the stream if needed.
6. Save the settings.
# Dashboard and Internal Tools
Source: https://docs.thefaithapp.com/product/dashboard-and-internal-tools
Use the admin dashboard, AI chat assistant, feature requests, support, notifications, and profile tools in TheFaithApp.
# Dashboard and Internal Tools
This guide covers the main admin tools used after sign-in.
These tools include:
* Dashboard
* AI Chat
* Feature Requests
* Support
* Push Notifications
* Profile
## Before You Start
* Sign in to your admin account.
* Open `Church Management` in the left sidebar to find `Dashboard`, `AI Chat`, and `Notifications`.
* `Profile`, `Feature Requests`, and `Support` are in the profile menu at the top right.
* Some tools only appear if your account has permission to use them.
## Dashboard
The dashboard is the first page after sign-in and gives a quick summary of church activity.
![Dashboard screen]()
### What You Can Do
* Review church information and branch count
* Download or copy the mobile app subscribe QR code
* Check totals for videos, audios, members, and donations
* Review recent media uploads and recent bulletins
* Open the donations report from the dashboard card
### Steps
1. Open `Church Management` in the left sidebar.
2. Click `Dashboard`.
3. Review the church information card.
4. Use `Download QR Code` or `Copy Link` if you want to share church mobile app access.
5. Scroll down to review media, bulletin, and membership summaries.
6. Open the donations report from the dashboard when needed.
### Notes
* Dashboard cards update based on the church data already in the system.
* If the mobile subscribe setup is incomplete, the QR section can show a warning instead of the QR code.
## AI Chat
AI Chat helps admins draft content and get guided help inside the admin workspace.
![AI Chat screen]()
### What You Can Do
* Start a new AI conversation
* Use suggested prompts to get started faster
* Type your own prompt
* Search past conversations
* Rename, archive, or delete saved conversations
### Steps
1. Open `Church Management`, then click `AI Chat`.
2. Choose a suggested prompt or type your own message.
3. Send the prompt.
4. Use `New chat` when you want to start over.
5. Open the action menu on a past conversation to rename, archive, or delete it.
### Notes
* Access depends on your admin role or AI Chat permission.
* If AI access is unavailable, the page shows a billing or reply-limit message with a link to `Settings`.
## Feature Requests
Use Feature Requests to send product ideas to the support team.
![Feature Requests screen]()
### Steps
1. Click your profile avatar in the top-right corner.
2. Select `Feature Requests`.
3. Enter a short title.
4. Describe the feature idea and why it would help.
5. Click `Send Feature Request`.
### Result
* The request is sent to the support team.
* Replies go to the email address on your admin account.
* A success message confirms the request was sent.
### Notes
* The title must be at least 5 characters.
* The message must be at least 20 characters.
## Support
Use Support when you need help with a question or issue.
![Support screen]()
### Steps
1. Click your profile avatar in the top-right corner.
2. Select `Support`.
3. Enter a short title for the issue or question.
4. Add the full details in the message box.
5. Click `Send Inquiry`.
### Result
* The inquiry is sent to the support team.
* Replies go to the email address on your admin account.
* A success message confirms the inquiry was sent.
### Tips
* Include what you were trying to do.
* Include any error wording or unexpected result.
* Add enough detail for the support team to reproduce the issue.
## Push Notifications
Use Push Notifications to send updates to church members.
![Push Notifications screen]()
### What You Can Do
* Create a new notification
* Search past notifications
* Edit an existing notification
* Resend an existing notification
* Delete a notification
### Steps
1. Click `Notifications` in the left sidebar.
2. Click `Create Notification`.
3. Enter the notification title.
4. Write the notification message.
5. Send the notification.
### Managing Existing Notifications
* Use the search field to filter the list.
* Use the edit icon to update a notification.
* Use `Resend` to send the same notification again.
* Use the delete icon to remove a notification.
### Notes
* Create and edit forms open in a right-side panel.
* Existing notifications appear as cards with quick actions.
## Profile
Use Profile to update your personal account details.
![Profile screen]()
### Steps
1. Click your profile avatar in the top-right corner.
2. Select `Profile`.
3. Update your name or email address.
4. Upload or remove the profile photo if needed.
5. Enter and confirm a new password if you want to change it.
6. Click `Save Changes`.
### Notes
* Leave the password fields blank if you do not want to change your password.
* Profile photos accept JPG or PNG uploads.
* The current account role is shown on the page.
# Discipleship overview
Source: https://docs.thefaithapp.com/product/discipleship
Start with one church-owned pathway, then add mentorship and spiritual practices when your ministry is ready.
# Discipleship
Discipleship is TheFaithApp's dedicated formation product. It helps a church
teach what it believes, walk with people over time, and offer spiritual
practices without turning a member's private life with God into an admin
dashboard.
Use it for membership classes, baptism preparation, new-believer foundations,
leadership development, mentoring, prayer rhythms, or a pathway created for
your own ministry context.
![The member Discipleship hub with an active pathway and formation practices]()
Discipleship is a top-level product. It uses your existing church members,
staff accounts, campuses, volunteer opportunities, and permissions, but it
does not live inside the Church Management menu.
## What you can build
Build sections, lessons, media, reflection prompts, discussions, and
optional or scored quizzes.
Coordinate mentor pairings while keeping personal goals and journals under
the member's control.
Offer a Rule of Life, Daily Office, Guided Examen, fasts, lament, the church
calendar, rest guides, and a Promise Ledger.
Understand what staff can see, what stays private, and which capabilities
are intentionally partial.
## A useful way to think about the product
| Part | What the church prepares | What the member experiences |
| ------------------- | ----------------------------------------------------------------------- | --------------------------------------------------------------------- |
| Pathways | Lessons, questions, enrollment rules, teachers, and completion settings | A clear class journey with progress and, when enabled, a certificate |
| Mentorship | Programs, meeting rhythm, mentor pairing, and a shared check-in prompt | A named mentor and a shared record of agreed next steps |
| Personal formation | Optional goal templates and invitations | Private goals, progress notes, and journal entries |
| Spiritual practices | Church-shaped liturgies, seasons, prompts, and guides | Prayer and reflection experiences designed for personal participation |
| Gifts and serving | A church-authored discernment instrument and skill links | Private results and relevant open serving opportunities |
The church provides structure and invitation. The member still owns the parts
of formation that should remain personal.
## Your first pathway in about 30 minutes
Start with a pathway your church already understands, such as baptism
preparation or membership foundations. Write down the outcome in one
sentence: **After this pathway, a learner should be able to...**
Ask one Discipleship manager to own setup, one teacher to maintain the
material, and one reviewer to check the content and correct answers before
publishing. One person may hold more than one role in a small church.
In the admin dashboard, open **Discipleship → Pathways → Create pathway**.
Begin from a church-editable template or a blank pathway. Every template is
only a starting point.
Add two or three lessons. Give each lesson a clear teaching point, a
Scripture reference, and one next action. Add a quiz only when a correct
understanding is genuinely required.
Check the member experience before inviting a whole class. Complete the
first lesson as the test member, confirm progress, and then review that
progress from the learner dashboard.
## Before you invite learners
Use this checklist for the first launch:
* Every required lesson has useful content.
* Required quizzes have at least one question and a confirmed correct answer.
* The passing score and attempt limit are compassionate and appropriate.
* The enrollment rule matches the ministry: open, approval-based, or
invite-only.
* Assigned teachers have the correct Discipleship permission.
* The completion message tells learners what happens next.
* Certificate wording and signatory are correct if certificates are enabled.
* A staff member has tested the published pathway in the member app.
A reliable first launch is more valuable than a large curriculum. Publish
one pathway, learn from a small group, and add mentorship or spiritual
practices when the ministry is ready to support them well.
## Who does what?
| Person | Typical responsibility |
| -------------------- | ------------------------------------------------------------------------------------------ |
| Discipleship manager | Creates pathways, assigns teachers, manages learners, and oversees the whole product |
| Teacher | Edits assigned pathways, teaches learners, and manages progress where permitted |
| Reviewer | Reviews assigned pathway content before publication |
| Progress viewer | Reads learner progress without changing enrollment or content |
| Member | Enrolls, completes lessons, participates in practices, and controls private formation data |
Permissions determine what a staff member may do. Assignment determines which
pathways or mentorship relationships they can access. Give each person only the
access they need.
## Where to go next
* Follow [Classes, quizzes, and learners](/product/discipleship-pathways) to
build your first complete pathway.
* Read [Mentorship and personal formation](/product/discipleship-formation)
before creating pairings or goal templates.
* Use [Spiritual practices](/product/discipleship-practices) when your church is
ready to add prayer and reflection rhythms.
* Review [Privacy, safety, and current scope](/product/discipleship-privacy)
before training staff.
# Mentorship and personal formation
Source: https://docs.thefaithapp.com/product/discipleship-formation
Coordinate shared mentorship while protecting private goals, journals, gifts results, and Rule of Life commitments.
# Mentorship and personal formation
Discipleship supports two different kinds of formation records:
* **Shared ministry records** help a mentor and mentee remember what they
agreed to discuss or do together.
* **Member-private records** help a person reflect, set goals, and discern
without creating a staff surveillance tool.
Keep that distinction clear when you train staff and members.
## Create a mentorship program
Open **Discipleship → Mentorship → New program**. Customize:
* Program name and description.
* Draft, active, or archived status.
* Expected duration.
* Weekly, every-two-weeks, monthly, or flexible meeting rhythm.
* The shared check-in prompt.
* Whether the member may add shared check-ins.
Activate the program when it is ready. A teacher can edit a program they
created; a Discipleship manager can manage every program.
### Write a safe check-in prompt
A good prompt prepares both people for a shared record:
> What did we agree to practice or revisit before our next conversation?
Avoid prompts that invite confidential disclosures into a shared field. For
example, do not ask for a full pastoral counseling note or a private confession.
## Pair a mentor and member
Discipleship managers select **Pair mentor**, then choose:
1. An active mentorship program.
2. An eligible mentor.
3. A member.
4. A start date.
In the current release, eligible mentors are existing staff who already have
the Discipleship management or teaching permission. This keeps the initial
workflow inside the church's staff authorization boundary.
An assigned mentor sees their own pairings. Managers can see all pairings.
Authorized staff can pause, resume, or complete a pairing without deleting its
history.
Lay-volunteer mentors depend on a future vetting and safeguarding workflow.
Do not grant unnecessary staff permissions simply to make a volunteer appear
in the mentor list.
## Keep shared check-ins
Open a pairing and select **Add check-in**. Record a shared conversation
summary and optional next steps. Check-ins are append-only and encrypted when
stored.
Every check-in is visible to both the mentor and mentee. Treat the saved text
as a shared agreement, not a private staff note. Correct a mistake with a new
check-in rather than silently rewriting the history.
## Offer private goal starting points
Open **Discipleship → Formation Tools → New goal template**. A template can
suggest:
* A name and description.
* Prayer, Scripture, community, service, rest, generosity, or another
formation area.
* A number of days.
* A private progress prompt.
* Draft, active, or archived availability.
An active template appears in the member app as an optional starting point.
Members may rename it, change its wording, or create a goal from scratch.
The admin dashboard shows the template—not who chose it, the member's goal
wording, progress, or private reflections.
## Private journal and class reflections
Members can open **Personal formation → Private journal** and create:
* A general reflection.
* A reflection linked to one of their own pathway enrollment cycles.
Entries are encrypted when stored. Only the member may read, edit, or
permanently delete them. Linking an entry to a class helps the member organize
their own history; it does not expose the journal to a teacher.
Class-linked reflections are available. Cohort-linked reflections are not
shown until a dedicated Discipleship cohort workflow exists.
## Build a gifts and serving instrument
Open **Discipleship → Gifts & Serving → New instrument**. Start with the
church-editable example or write your own. Customize:
* Introduction and low/high response labels.
* Gift or temperament areas and descriptions.
* Reflection questions and the area each answer contributes to.
* Question weights.
* Serving skills connected to each area.
* The delay before an unused strong gift is gently resurfaced.
In **Volunteers → Opportunities**, connect active opportunities to their
serving skills. Published results can then recommend open opportunities with a
plain-language reason for the match.
### Publish without changing old results
Publishing creates an immutable instrument version. Later question or scoring
changes do not alter an earlier member result. That preserves the meaning of
what the member originally completed.
Answers and results are encrypted and private. Instrument authors do not get
an answer or result dashboard.
A member with an active staff mentorship pairing may deliberately share one
result with their assigned mentor. Only that mentor can open it, add an
affirmation, and see it while access remains shared. The member can revoke
access at any time.
## Build a seasonal Rule of Life
Open **Discipleship → Rule of Life → New season**. Customize:
* Church-season name, dates, and invitation.
* Opening covenant and closing reflection prompts.
* Practice titles, guidance, and example rhythms.
* Required and optional practices.
* Draft, active, or archived availability.
Every template keeps prayer, rest, work, and generosity represented, while
your church owns the language and may add other practices.
Members create a fresh private draft for each season, personalize its
practices, covenant the rule, revise it during the season, and close it with a
private reflection.
The dashboard contains templates only. A member's covenant, commitments, and
closing reflection are encrypted and owner-only. Rule of Life intentionally
has no streaks, scores, or staff progress dashboard.
## A simple staff training script
Use this explanation before launching personal formation:
> The church creates invitations and starting points. Your personal goals,
> journal, gifts result, and Rule of Life remain yours. A mentorship check-in
> is different: it is a shared record that both mentor and mentee can read.
## Privacy summary
| Record | Member | Assigned mentor | Other staff |
| ------------------------- | -------------------- | --------------------------------------- | ------------------------------ |
| Mentorship check-in | Reads shared history | Reads shared history | Managers only where authorized |
| Personal goal and updates | Full control | No access | No access |
| Private journal | Full control | No access | No access |
| Gifts result | Full control | Only when the member shares that result | No results dashboard |
| Rule of Life | Full control | No access | Templates only |
For the full boundary, read [Privacy, safety, and current scope](/product/discipleship-privacy).
## Common problems
The person must be an eligible staff user with the correct Discipleship
permission. Do not widen access unless their ministry role requires it.
This is expected. Goal and journal content is member-private by design.
Confirm the opportunity is active and available, then connect its serving
skills to the gift areas in the published instrument.
This is expected. Each result stays tied to the instrument version the
member completed.
# Classes, quizzes, and learners
Source: https://docs.thefaithapp.com/product/discipleship-pathways
Build, publish, and run a complete church-owned learning pathway from the admin dashboard.
# Classes, quizzes, and learners
A **pathway** is a course or formation journey made from ordered sections and
lessons. Your church owns every word, question, answer, enrollment rule, and
completion setting.
## Choose the enrollment style first
| Enrollment | Best for | What the member sees |
| -------------- | ---------------------------------------------------- | ------------------------------------------------------------- |
| Open | Foundations or resources anyone may begin | **Enroll** and immediate access |
| Approval-based | Classes that need a conversation or scheduled cohort | **Request access**, followed by a pending state |
| Invite-only | Leadership, sensitive, or staff-selected training | The pathway remains locked until a teacher enrolls the member |
Choose this early because it determines how learners enter the pathway. You
can change it before publishing.
## Create the pathway
1. Open **Discipleship → Pathways**.
2. Select **Create pathway**.
3. Choose **Blank pathway** or a church-editable template.
4. Give the pathway a clear title and short description.
5. Select **Continue to builder**.
![The Discipleship pathway builder with sections, lessons, content, and settings]()
Templates include common starting points such as membership foundations,
baptism preparation, new-believer foundations, serving foundations, and
leadership foundations. Replace any wording that does not fit your church.
## Build sections and lessons
Use sections to group related lessons. A membership pathway might look like:
```text theme={null}
Section 1 — Our story and beliefs
Lesson 1 — Welcome and church story
Lesson 2 — What we believe
Section 2 — Belonging and participation
Lesson 3 — Community and care
Lesson 4 — Serving and next steps
```
Each lesson can include:
* A title, summary, and expected time.
* Teaching text and Scripture.
* Video or audio links.
* Downloadable files.
* Reflection and group-discussion prompts.
* Required acknowledgements.
* Questions or a quiz.
Mark a lesson **required** only when it must count toward pathway completion.
Keep lessons focused; a short lesson with one clear next action is usually
easier to complete than an entire class session on one screen.
## Add questions and quizzes
Open a lesson and select **Add questions or a quiz**. Supported question types
are:
* Single choice.
* Multiple choice.
* True or false.
* Short answer.
For each question, write the prompt, accepted or correct answer, point value,
and an optional explanation. Correct answers are never sent with the lesson
content shown to the member.
### Decide whether a quiz is required
Use an optional quiz for self-checking. Use a required quiz when the learner
must demonstrate a clear understanding before continuing. For a required
quiz, set:
* The passing percentage.
* The maximum number of attempts.
* A helpful explanation for incorrect answers where appropriate.
Do not score experiences that need prayerful reflection rather than a correct
answer. Use reflection or discussion prompts for those moments.
Test every correct answer before publishing. A learner who uses all allowed
attempts needs help from the teacher; do not use a strict attempt limit
without a support plan.
## Configure completion
Pathway settings include:
* Pathway type and expected number of weeks.
* Enrollment style.
* Whether a completed or removed learner may repeat the pathway.
* The waiting period before a member-initiated repeat.
* Completion message.
* Certificate eligibility, title, award wording, signatory, and accent color.
If repeat enrollment is enabled, a new cycle uses the currently published
version and preserves the earlier journey. Approval-based repeats return to
pending review; invite-only repeats still require a teacher. Authorized staff
can start a repeat cycle even when the member waiting period has not ended.
When certificates are enabled, completing every required lesson issues a PDF
with a public verification code. The certificate keeps a snapshot of the
published wording used for that learner.
## Assign teachers and reviewers
Open **Teachers** in the builder. A Discipleship manager can assign:
* **Teacher** — may customize and maintain the assigned pathway.
* **Reviewer** — may inspect the assigned pathway before publication.
The creator remains the pathway owner. A staff member must already have an
appropriate Discipleship permission before they can be assigned.
## Publish safely
Publishing creates a fixed version. Learners already enrolled remain on the
version they started; later edits do not change their lessons or answers
halfway through the class.
Before selecting **Publish**:
1. Preview every required lesson.
2. Confirm required quizzes contain questions.
3. Check correct answers, score, and attempt limits.
4. Confirm enrollment and repeat rules.
5. Review the completion message and certificate.
6. Save the draft, then publish.
To make later changes, edit the draft and publish a new version. Do not expect
existing learners to move to it automatically.
## Manage learners
![The Discipleship pathway workspace with a published populated class]()
Open **Learners** from a pathway card or the builder. Authorized staff can:
* Approve or deny pending requests.
* Add existing church members.
* Search and filter enrollments.
* Review lesson completion and overall progress.
* Pause, reactivate, or remove an enrollment.
* Start a repeat cycle.
* Download, verify, or revoke a certificate.
A progress viewer can read progress but cannot change access. Revoked
certificates remain in the audit trail and fail public verification.
## Review formation history
Open **Discipleship → Formation History** for a cross-pathway view. It shows
each enrollment cycle, the pathway and version used, progress, dates, status,
and any issued or revoked certificate.
History is intentionally cycle-based. A second journey through the same
pathway never erases the first one.
## What the member experiences
In the mobile app, a member can review the outline, enroll or request access,
continue the next lesson, answer quizzes, see scores and remaining attempts,
track progress, finish the pathway, and access an eligible certificate.
They can also open **Formation History** to revisit earlier cycles and begin a
repeat when the pathway rules allow it.
## Common problems
Confirm the pathway is published, the member belongs to the same church,
and its enrollment style allows discovery. Invite-only pathways require a
staff enrollment.
Confirm both pieces of access: the teacher needs a Discipleship permission
and an assignment to that pathway.
Check whether another required lesson item is incomplete or a required
quiz has not reached the passing score.
The learner may be using an earlier published version. That protects an
in-progress class from changing. New enrollments use the current version.
# Prayer and spiritual practices
Source: https://docs.thefaithapp.com/product/discipleship-practices
Create church-shaped prayer, reflection, fasting, lament, calendar, rest, and promise-review experiences.
# Prayer and spiritual practices
Spiritual practices give members a formation rhythm beyond a class. Your
church prepares the invitation, language, and structure; members decide how
and when to participate.
Start with one practice your church can pastor well. Test it with staff before
publishing it to members.
## Daily Office
Open **Discipleship → Daily Office → New plan**. Configure:
* Title, active dates, and IANA timezone.
* Up to eight fixed prayer hours and their gentle bell invitations.
* Introduction and full order of prayer.
* Headings, readings, Scripture, prayers, responses, and timed silence.
* Draft, active, or archived availability.
Members choose which hours ring on their own device. Active liturgies are saved
for offline use, and the local bell schedule refreshes when Daily Office opens.
![A populated Daily Office plan with member-selected local prayer bells]()
Live presence is anonymous and temporary. A member may see **You and 3 others
are praying now** while an office is open. Staff cannot see identities, bell
choices, individual presence, or attendance history.
## Guided Examen
Open **Discipleship → Guided Examen → New Examen**. Configure:
* Title and suggested evening time.
* Opening and closing words.
* Ordered reflection steps and guidance.
* Presence, gratitude, review, consolation, desolation, forgiveness, tomorrow,
or custom step types.
* Optional or required written responses.
* Automatic deletion from one hour to 30 days.
* Draft, active, or archived availability.
Every Examen must include gratitude and desolation. The church owns the
remaining language and order.
The deletion clock starts when the member begins; completion does not extend
it. Responses are encrypted and owner-only. The member may delete early, and
the platform permanently deletes the full session at expiry. Staff cannot
inspect responses, participant names, or completion activity.
## Congregational fasts
Open **Discipleship → Congregational Fasts → New fast**. Configure:
* A one-to-90-day window and church timezone.
* Invitation, safety guidance, and closing blessing.
* At least one shared standard and one body-safe substitution.
* Up to eight total participation practices.
* Daily Scripture, reflection, and prayer.
* Draft, published, or archived availability.
Every option is presented as full participation. Members choose privately and
are never asked to submit a health reason.
Selected practices and daily check-ins are encrypted and owner-only. Staff see
only a total participant count—not names, choices, or check-ins. Leaving the
fast permanently deletes that member's participation record.
Write the safety guidance before writing the fast invitation. Include
substitutions that are genuinely accessible and encourage members to follow
appropriate medical advice.
## Lament and Wall of Tears
Open **Discipleship → Lament & Wall of Tears → New liturgy**. Configure:
* Invitation, opening, and closing words.
* Ordered psalm, naming, protest, petition, silence, or custom movements.
* Whether the optional Wall of Tears is available.
* Wall heading, introduction, and offering prompt.
* Permanent deletion from one to 365 days.
* Draft, active, or archived availability.
Every liturgy retains at least one psalm and one naming movement. It does not
force grief toward a quick conclusion.
Private writing inside the liturgy stays only in memory on the current mobile
screen and is never uploaded. The Wall of Tears uses a separate blank field;
private words are never copied into it.
A wall offering is encrypted and waits for moderation. If approved, it appears
without the author's name. Moderators see the author only when the member
explicitly permits pastoral follow-up. Approval never extends the deletion
date, and the member may permanently delete the offering sooner.
## Living Church Calendar
Open **Discipleship → Church Calendar → New church year**. The included dates
are an editable Western-calendar example. Review every date against your
church tradition before activation.
Configure:
* Church-year title, description, dates, and timezone.
* Member welcome.
* Two to twelve non-overlapping seasons.
* Each season's name, dates, color, tone, invitation, and Scripture.
* Up to eight prayer, Scripture, generosity, fasting, service, rest,
reflection, or custom practices per season.
* Daily, weekly, once-per-season, or flexible rhythm.
* Draft, active, or archived availability.
Only one church year may be active at a time. The member companion uses the
church timezone to move from one season to the next.
The calendar stores no attendance, completion, streak, or spiritual score.
## Sabbath and Retreat
Open **Discipleship → Sabbath & Retreat → New rest guide**. Configure:
* Sabbath or retreat type.
* Members, clergy, or everyone as the intended audience.
* Default duration from 30 minutes to seven days.
* Opening and closing invitations.
* Scripture reference.
* One to eight suggested practices.
* Draft, active, or archived availability.
Members decide whether to start, may change the duration, and can end early.
Only the current rest window is retained; expired and ended windows are
removed. Staff receive no participation analytics.
Notification protection is partial. Rest mode mutes the church-wide
broadcast topic on the member's device, including while the app is closed.
Direct chat, care, prayer-room, volunteer, and other token-targeted alerts
are not muted yet. Clergy-device enforcement also depends on future unified
notification preferences and a signed-in staff mobile identity.
## Private Promise Ledger
Open **Discipleship → Promise Ledger → New invitation**. Configure:
* Title and explanation.
* A gentle private-review question.
* Review interval from one to 90 days.
* Whether to include active personal goals, committed Rule of Life promises,
or both.
* Draft, active, or archived availability.
The ledger reads only explicit structured commitments. It never scans journals
or infers promises from free-form writing.
Members can add an encrypted review note, snooze an item, set it aside, or
restore it. A review does not mark the source complete and creates no streak or
score. When the original goal or Rule of Life promise is no longer current,
its review state is removed.
The dashboard shows the invitation only—not member promises, notes, due counts,
or activity.
## Launch checklist for any practice
* The language sounds like your church and has been pastorally reviewed.
* Dates and timezone are correct.
* Privacy expectations are explained before participation.
* Safety language exists where the practice affects the body or sensitive
personal experience.
* A staff member completed the whole member flow on a phone.
* Draft, active, published, and archived states behave as expected.
* Your ministry knows how to respond if a member asks for help.
## Common problems
Confirm it is active or published, its date window includes today where
required, and the church timezone is correct.
This is intentional for private practices. Some workflows provide only an
anonymous total; others provide no participation analytics at all.
Confirm the member selected the prayer hour, allowed notifications on the
device, and reopened Daily Office after a plan or schedule change.
Direct and token-targeted notifications are outside the current partial
protection. The member app explains this boundary before rest begins.
# Privacy, safety, and current scope
Source: https://docs.thefaithapp.com/product/discipleship-privacy
Understand who can see Discipleship data, how publishing protects learners, and which capabilities are intentionally partial.
# Privacy, safety, and current scope
Discipleship is designed around a simple boundary:
> The church may provide structure, teaching, and support without turning the
> admin dashboard into a window onto a member's private spiritual life.
This page should be part of staff onboarding—not only a technical reference.
## What staff can see
Authorized staff can see information needed to run a shared ministry workflow:
* Pathway enrollment, required lesson progress, quiz outcome, and completion.
* Published-version history and certificates.
* Mentor pairings and check-ins that are explicitly shared with both people.
* A gifts result only when the member shares that specific result with their
assigned mentor.
* Anonymous or aggregate participation where a practice explicitly provides
it, such as a fast participant total.
* A Wall of Tears author's identity only when the author requested pastoral
follow-up.
## What remains member-private
Staff cannot inspect:
* Personal goal wording, updates, or private progress reflections.
* General or class-linked private journal entries.
* Gifts instrument answers or unshared results.
* Rule of Life drafts, covenants, commitments, or closing reflections.
* Daily Office bell preferences, identities, or attendance history.
* Guided Examen responses or participation.
* Fast choices, health reasons, or daily check-ins.
* Private writing composed inside a lament liturgy.
* Church Calendar participation or completion.
* Rest participation history.
* Promise Ledger items, notes, due counts, or review activity.
## Visibility matrix
| Experience | Church configures | Staff may review | Member-private data |
| ------------------- | ----------------------------------------- | ---------------------------------------------- | ------------------------------ |
| Pathway | Content, quizzes, enrollment, certificate | Enrollment and learning progress | Private journal reflection |
| Mentorship | Program and shared prompt | Shared check-ins within authorization | Separate goals and journal |
| Personal goals | Optional templates | Templates only | Goal, updates, reflections |
| Gifts and serving | Instrument and skill mapping | Deliberately shared result only | Answers and default result |
| Rule of Life | Seasonal template | Template only | Covenant and commitments |
| Daily Office | Plan, hours, liturgy | No identities or attendance | Bell choices and participation |
| Guided Examen | Template and deletion window | No responses or activity | Full session until deletion |
| Congregational fast | Campaign and daily guide | Aggregate participant count | Choice and check-ins |
| Lament | Liturgy and wall moderation | Moderated offering; identity only with consent | In-liturgy private writing |
| Church Calendar | Seasons and practices | No member activity | No activity record is created |
| Sabbath and Retreat | Guides | No participation analytics | Current private rest window |
| Promise Ledger | Invitation and interval | Invitation only | Items, notes, and reviews |
## Privacy-aware staff habits
* Explain whether a field is shared before a person writes in it.
* Do not ask members to copy private journal content into a shared check-in.
* Do not use quiz scores as a measure of spiritual maturity.
* Do not widen staff permissions to solve a convenience problem.
* Do not export, screenshot, or copy sensitive formation content into another
system.
* Use the dedicated pastoral-care workflow for confidential care—not a
mentorship check-in.
* Treat anonymous totals as ministry context, not evidence about individuals.
## Publishing and version safety
Publishing a pathway or gifts instrument creates an immutable version.
Learners and results remain attached to the version they began. Later edits
create a new version instead of silently changing past or in-progress data.
This protects:
* The questions and answers used in a quiz attempt.
* The curriculum a learner was asked to complete.
* The certificate wording issued at completion.
* The questions and scoring behind a gifts result.
## Deletion and retention behavior
| Data | What happens |
| --------------------- | ------------------------------------------------------------------------------------------------------- |
| Private journal | Member may permanently delete an entry |
| Guided Examen | Member may delete early; otherwise the complete session is permanently deleted at the configured expiry |
| Fast participation | Leaving permanently removes that participation record |
| Wall of Tears | Member may delete early; remaining offerings are permanently deleted on the fixed schedule |
| Rest window | Ended and expired windows are removed |
| Promise Ledger review | Removed when the original commitment is no longer current |
| Certificate | Revocation preserves the audit record but invalidates public verification and download |
## Current partial or dependent capabilities
These boundaries are visible in the product so staff do not promise behavior
that does not exist yet:
* **Sabbath and Retreat notification protection is partial.** Church-wide
broadcast-topic notifications are muted, but direct chat, care, prayer-room,
volunteer, and other token-targeted alerts are not.
* **Clergy-device rest enforcement is partial.** It depends on a signed-in
staff mobile identity and unified notification preferences.
* **Lay-volunteer mentor eligibility is dependent.** It needs an appropriate
vetting and safeguarding workflow.
* **Cohort-linked journals are dependent.** Class-linked private reflections
work now; a dedicated Discipleship cohort workflow does not yet exist.
“Partial” means the documented working portion can be used now, but the full
intended behavior depends on another feature. “Dependent” means the product
does not present that capability as available yet.
## Public API availability
Discipleship currently runs through TheFaithApp's first-party admin dashboard
and member apps. It is not yet included in the supported public partner `v1`
API.
Do not build third-party integrations against admin or internal mobile routes.
They are private implementation surfaces and may change without partner API
versioning guarantees. Read [Discipleship API availability](/api-reference/discipleship)
for the public integration boundary.
## Staff launch checklist
* Staff understand the difference between shared mentorship and private
formation.
* Permissions match real ministry responsibilities.
* Published content and correct answers have been reviewed.
* Members receive an honest privacy explanation.
* Staff know which data is intentionally unavailable to them.
* Partial capabilities are described accurately.
* A support and safeguarding path exists for members who need help.
# Engagement and Communication
Source: https://docs.thefaithapp.com/product/engagement-and-communication
Manage prayer requests, notifications, direct messages, group chats, invitations, and member-facing saved items in TheFaithApp.
# Engagement and Communication
This guide covers the communication tools your team can use to receive prayer requests, send announcements, and stay connected inside TheFaithApp.
These tools include:
* Prayer requests
* Public prayer request forms
* Notifications
* Direct messages
* Group chats
* Group invitations
* Favorites and bookmarks
## Before You Start
* Sign in to your admin account.
* Open `Prayer Requests`, `Notifications`, or `Chat` from the left sidebar depending on the task you want to complete.
* Keep public links ready before you share them outside the admin dashboard.
* Review new requests and conversations regularly so follow-up does not stall.
## Prayer Requests
Use the prayer requests workspace to review submitted requests, track follow-up status, and share a public prayer request form.
![Prayer requests screen]()
### What You Can Do
* Review prayer request totals
* See recent requests quickly
* Search requests
* Filter by status
* Filter by request audience
* Filter by urgency status
* Filter by date range
* Open an individual request
* Export the current list
* Generate a public prayer request link
* Update prayer request settings
### Steps
1. Open `Prayer Requests`.
2. Review the summary cards and the recent requests section at the top.
3. Use search, status, audience, or date filters to narrow the request list.
4. Click the view icon when you need the full request details.
5. Use `Export`, `Generate Public Link`, or `Settings` when needed.
### Notes
* The request list is the main place for ministry teams to review incoming needs.
* Status updates make it easier for several team members to stay aligned on follow-up.
## Reviewing a Prayer Request
Use the request drawer when you need the full message and want to update the follow-up status.
![Prayer request view drawer]()
### What You Can Do
* Read the full request
* Review requester details
* Confirm whether the request is for the Church Prayer Wall, a Community
Group, church leaders, or the pastoral team
* See answered and withdrawn request state
* Update the request status
* Review a member's private request for urgent follow-up
* Assign an urgent response owner and track acknowledgement, work, and
resolution
* Create a locked Prayer Room with an eligible verified prayer-team leader
* Create and update a bounded Pastoral Care handoff
* Review pastoral access history when the request uses the restricted
pastoral-only audience
### Steps
1. Open `Prayer Requests`.
2. Click the view icon for the request you want to review.
3. Read the message and confirm the requester details.
4. Update the status based on your current follow-up stage.
For a request marked for urgent review:
1. Review the member's private reason and approve or decline the urgency
request.
2. Assign a staff owner when follow-up is needed.
3. Record when the need is acknowledged, in progress, and resolved.
4. If live prayer is appropriate, choose an eligible verified prayer-team
leader and create a private Prayer Room.
5. If broader care coordination is needed, create a Pastoral Care handoff with
a reason, owner, and short coordination note.
### Notes
* This view is useful for pastors, prayer teams, and follow-up coordinators.
* Recent requests at the top of the main page can also be opened from there.
* A withdrawn request cannot be returned to a member Prayer Wall.
* Member prayer journals remain private and never appear in this workspace.
Only a request the member deliberately shares from a journal enters the
normal review list.
* Urgency is private and does not appear as a badge on the member Prayer Wall.
* Urgent notifications contain a safe general message rather than the prayer
text, requester identity, contact details, or private reason.
* The Pastoral Care handoff records coordination metadata only. It does not
copy prayer or contact details, and it is not a full confidential care case.
* Pastoral-only requests require both Prayer Requests and Private Pastoral
Prayer Requests access. Their content is encrypted, excluded from general
search and export, and never shared into Prayer Walls, prayer teams, Prayer
Rooms, or AI tools.
* When the pastoral audience filter is selected, `Export metadata` downloads
workflow fields only and records the export in the request's access history.
## Public Prayer Request Links
Use the public link tool when your church wants people to submit requests without entering the admin dashboard.
![Prayer request link modal]()
### What You Can Do
* Copy the public prayer request link
* Copy embed code for another website
* Share one destination for members, visitors, or livestream viewers
### Steps
1. Open `Prayer Requests`.
2. Click `Generate Public Link`.
3. Copy the direct link or the embed code.
4. Share it where people already reach your church online.
### Notes
* Public requests still flow back into the main prayer request review list.
* Public-form requests default to church leaders only and do not automatically
appear in a member Prayer Wall.
* The embed option is useful when you want the form placed inside a church website.
## Public Prayer Request Page
Use the public page to collect requests from members, visitors, or online viewers.
![Public prayer request page]()
### What You Can Do
* Submit a prayer request outside the admin dashboard
* Collect contact details for follow-up
* Give people a simple support path from a website or shared link
### Steps
1. Generate or copy the public prayer request link from the admin dashboard.
2. Share the link anywhere people already connect with your church.
3. Open the page outside the dashboard.
4. Fill in the request details and submit the form.
### Notes
* Review this inbox regularly so public requests receive timely follow-up.
## Notifications
Use notifications to send updates and announcements to your audience.
![Notifications screen]()
### What You Can Do
* Review existing notifications
* Search notifications
* Create new notifications
* Edit a notification
* Resend a notification
* Delete a notification
### Steps
1. Open `Notifications`.
2. Review the existing list or use search to find a past message.
3. Click `Create Notification` when you need to send a new update.
4. Use the action menu to edit, resend, or delete an existing notification.
### Notes
* Resend is useful when an important message needs another pass without rebuilding it.
* The list view helps teams keep track of what has already been sent.
## Creating a Notification
Use the create drawer when you need to prepare a new announcement for delivery.
![Create notification drawer]()
### What You Can Do
* Add a notification title
* Write the notification body
* Send the update from the same drawer
### Steps
1. Open `Notifications`.
2. Click `Create Notification`.
3. Enter the notification title.
4. Write the message body.
5. Click the send button to publish the notification.
### Notes
* A clear title and short message body usually work best for church-wide announcements.
## Chat Workspace
Use chat to keep one-to-one and group conversations active across the admin dashboard and the mobile app.
![Group chat workspace]()
### What You Can Do
* Switch between `Personal` and `Groups`
* Search conversations from the chat list
* Review the latest message and time for each room
* Read and reply to messages
* See unread activity when new messages arrive
* Open a room and continue the conversation
* Start a new chat from the admin dashboard when your role allows it
### Steps
1. Open `Chat`.
2. Use `Personal` or `Groups` to switch conversation types.
3. Select the conversation you want from the list.
4. Read the latest messages in the thread.
5. Type your reply, attach a supported file, or attach a sermon.
6. Send the message.
### Notes
* The shared chat workspace keeps direct messages and group threads in one place.
* Messages update in realtime between the admin dashboard and mobile app.
* Group chats work well for ministry teams, church-wide updates, internal coordination, and recurring planning.
## Direct Messages
Use direct messages when you need a one-to-one conversation with a member or another user.
![Personal chat screen]()
### What You Can Do
* Open an existing direct message
* Continue a private conversation
* Reply inside the same thread
### Steps
1. Open `Chat`.
2. Stay on `Personal`.
3. Select the conversation you want to open.
4. Type your message and send it.
### Notes
* Direct messages are best for one-to-one follow-up, coordination, or support.
* Direct message notifications follow the recipient's chat notification preferences.
## Group Chat Messages
Use group chats when several members need to follow the same conversation.
![Rich group chat messages]()
### What You Can Do
* Read messages grouped by date
* See read receipts such as `Seen by 1` or `Seen by 5`
* Reply to a specific message
* React with quick faith-community reactions
* Mention another member in a group
* Play sermon attachments from the message
* Listen to voice notes
* Delete messages when your role allows moderation
### Steps
1. Open `Chat`.
2. Click `Groups`.
3. Open the group you want.
4. Scroll up to review older messages.
5. Use `Reply` when you want your response linked to a message.
6. Use a reaction when a short response is enough.
7. Type `@` and choose a member when you need to mention someone.
### Notes
* New messages appear without refreshing the page.
* The unread divider marks where new activity begins when you return to a room.
* Mentioned members receive stronger chat attention based on notification settings.
## Attachments, Voice Notes, and Sermons
Use attachments when a conversation needs more than text.
![Mobile sermon attachment in chat]()
### What You Can Do
* Send supported image attachments
* Send supported PDF attachments
* Preview images from the chat room
* Open PDFs from the chat room
* Attach audio or video sermons
* Play sermon attachments from the chat card
* Send and play voice notes on mobile
### Steps
1. Open the chat room.
2. Click or tap the attachment icon for an image or PDF.
3. Choose the file and wait for the upload to finish.
4. Use the sermon icon when you want to attach a sermon.
5. Search for the sermon and select it.
6. Send the message.
### Notes
* Chat file attachments currently support images and PDFs.
* Sermon attachments open in the mobile app player on mobile.
* On web, sermon attachments use browser playback controls.
* Upload progress appears before the message finishes sending.
## Group Info and Members
Use the group info drawer to review members and shared content from one place.
![Group info drawer]()
### What You Can Do
* Review the group name
* Confirm whether the group is public or private
* See the current member count
* Review members
* Load more members in larger groups
* Review shared photos
* Review shared PDF files
* Review shared sermons
* Open shared files or sermons from the drawer
* Mute or moderate members when your role allows it
### Steps
1. Open `Chat`.
2. Click `Groups`.
3. Open the group conversation you want.
4. Click the group header.
5. Use `Members`, `Photos`, `Files`, or `Sermons` to review the shared group history.
6. Open a shared photo, PDF, or sermon when you need to preview it.
## Joining Public Groups
Use public groups when members should be able to read a room before joining the conversation.
### What You Can Do
* Open a public group from the chat list
* Read the existing conversation
* Review group details before joining
* Join the group when you want to participate
### Steps
1. Open the mobile app.
2. Go to `Chat`.
3. Open the public group you want to view.
4. Review the messages or group details.
5. Tap `Join` when you want to send messages in that room.
### Notes
* Members who have not joined can read the room, but they do not see the message input until they join.
## Chat Notification Preferences
Use notification preferences when a room is useful but temporarily too busy.
### What You Can Do
* Keep notifications on for important rooms
* Mute a room for a short period
* Mute a room for the day
* Turn off room notifications when needed
* See which mute option is currently selected
## Favorites and Bookmarks
Use favorites and bookmarks as member-side save-for-later tools inside the app experience.
### What You Can Do
* Save content for quick return later
* Help members keep track of meaningful sermons or devotional content
* Support follow-up when a member says they saved an item to revisit
### Notes
* Favorites and bookmarks are member-facing features rather than a separate admin workspace.
* The current web dashboard does not expose a standalone favorites or bookmarks management page.
## Current Product Notes
* The admin pages reviewed for this guide include prayer requests, notifications, direct messages, group chats, room details, and chat moderation actions.
* Chat rooms are created and managed from the admin experience.
* Favorites and bookmarks remain member-facing saved-item features.
# Events and Volunteers
Source: https://docs.thefaithapp.com/product/events-and-volunteers
Plan church events, configure registration, and manage volunteer ministries, opportunities, skills, and signups in TheFaithApp.
# Events and Volunteers
This guide covers the main tools used to manage events and volunteer coordination in TheFaithApp.
These tools include:
* Events
* Event categories
* Event registration setup
* Volunteer ministries
* Volunteer categories
* Volunteer skills
* Volunteer opportunities
* Volunteer signups
## Before You Start
* Sign in to your admin account.
* `Events` and `Volunteers` are in the left sidebar.
* Some create, edit, or delete actions depend on your admin permissions.
## Event Categories
Use Event Categories to organize events by theme, audience, or purpose.
![Event categories screen]()
### What You Can Do
* Create a new event category
* Add a description and color
* Mark a category as active or inactive
* Search categories
* Edit or delete existing categories
### Steps
1. Open `Events`.
2. Select `Event Categories`.
3. Click `Add new`.
4. Enter the category name, description, and color.
5. Set the category status if needed.
6. Save the category.
### Tips
* Use category names that make event filtering easier for your team.
* Keep inactive categories for older event types you do not want to remove yet.
## Events
Use Events to publish upcoming services, outreach programs, conferences, and other church activities.
![Events screen]()
### What You Can Do
* Create a new event
* Add a cover image, date, time, and location
* Assign the event to a category
* Search events
* Filter by category
* Edit or delete existing events
* Turn on recurring or multi-day scheduling when needed
### Event Details
* Event title
* Event description
* Date and time
* Cover image
* Category
* Location name and address
* Recurring or multi-day options
### Steps
1. Open `Events`.
2. Click `Add new`.
3. Enter the event title and description.
4. Add the date, time, and cover image.
5. Choose the event category.
6. Add the location details.
7. Save the event.
### Notes
* Event cards show the key details at a glance, including date, time, location, and whether registration is enabled.
* Past events remain visible with a visual status change, which helps with reference and cleanup.
## Event Registration Setup
Use event registration when attendees need to confirm participation before the event date.
![Event registration settings]()
### What You Can Set
* Whether registration is required
* Built-in registration or an external registration link
* Registration capacity
* Registration deadline
* Contact person name and email
### Steps
1. Open `Events`.
2. Create a new event or edit an existing one.
3. Turn on `Registration Required`.
4. Choose the registration type.
5. Add the capacity if you want to limit attendance.
6. Set the registration deadline.
7. Add the contact person details.
8. Save the event.
### Notes
* Built-in registration is best when you want attendance managed inside the platform experience.
* Use an external registration link if your church already relies on another signup tool.
* In the current web event pages reviewed for this guide, registration is configured on the event form itself rather than through a separate registrations, check-in, or export screen.
## Volunteer Ministries
Use Volunteer Ministries to group opportunities under larger service teams.
![Volunteer ministries screen]()
### What You Can Do
* Create a ministry
* Add a short description
* Search ministries
* Review how many opportunities belong to each ministry
* Edit or delete ministries
### Steps
1. Open `Volunteers`.
2. Select `Ministries`.
3. Click `Add Ministry`.
4. Enter the ministry name and description.
5. Save the ministry.
## Volunteer Categories
Use Volunteer Categories to organize opportunities by type of service.
![Volunteer categories screen]()
### What You Can Do
* Create categories for different service areas
* Search categories
* Review opportunity counts by category
* Edit or delete categories
### Steps
1. Open `Volunteers`.
2. Select `Categories`.
3. Click `Add Category`.
4. Enter the category name and description.
5. Save the category.
## Volunteer Skills
Use Volunteer Skills to track the abilities that can be matched to volunteer opportunities.
![Volunteer skills screen]()
### What You Can Do
* Create a skill
* Describe what the skill is used for
* Search skills
* Review how many opportunities and members are linked to each skill
* Edit or delete skills
### Steps
1. Open `Volunteers`.
2. Select `Skills`.
3. Click `Add Skill`.
4. Enter the skill name and description.
5. Save the skill.
## Volunteer Opportunities
Use Volunteer Opportunities to publish open serving roles and manage needed capacity.
![Volunteer opportunities screen]()
### What You Can Do
* Create a new opportunity
* Assign it to a ministry and category
* Set location, date, and time
* Define how many volunteers are needed
* Require approval before a signup is accepted
* Filter by ministry, category, or status
* Open signup requests for review
* Edit or delete opportunities
### Opportunity Details
* Title and description
* Ministry
* Category
* Location
* Date and time
* Volunteer slots needed
* Status
* Approval requirement
### Steps
1. Open `Volunteers`.
2. Select `Opportunities`.
3. Click `Add Opportunity`.
4. Enter the opportunity details.
5. Choose the ministry and category if needed.
6. Set the date, time, and location.
7. Add the number of volunteer slots.
8. Turn on approval if your team wants to review requests first.
9. Save the opportunity.
### Notes
* Opportunity cards show the number of filled and open volunteer spots.
* Active opportunities are easier for team leads to review from one page.
## Volunteer Signups
Use the signups drawer to review volunteer requests for a specific opportunity.
![Volunteer signups drawer]()
### What You Can Do
* Review incoming signups
* Filter signups by status
* Approve or reject pending requests
* Remove a signup when needed
### Steps
1. Open `Volunteers`.
2. Select `Opportunities`.
3. Find the opportunity you want to review.
4. Click `View Signups`.
5. Use the status filter if you want to narrow the list.
6. Approve or reject pending requests from the actions column.
### Notes
* Opportunity cards show the current signup count before you open the drawer.
* Approval-based workflows are useful when volunteer roles have limited spaces or need team-lead review first.
# Forms
Source: https://docs.thefaithapp.com/product/forms
Create church forms, publish them on the web or member app, and turn every response into an organized follow-up workflow.
# Forms
Forms gives your church one place to create flexible forms, share them, and
coordinate what happens after someone responds. Use Forms for connection cards,
ministry interest, membership next steps, feedback, pastoral requests, internal
requests, and other church workflows that do not belong to a specialized
product.
Each response stays attached to the exact version of the form that the person
completed. Your team can assign an owner, set a due date and priority, add
private notes, and keep an activity history without moving the response into a
separate spreadsheet.
![Forms library]()
## Before You Start
Make sure that:
* At least one administrator has permission to manage Forms.
* Staff who will review responses have response access.
* Sensitive or restricted forms have named form managers.
* The church's privacy wording and follow-up owner are agreed before publishing.
* Any custom domain you want to use is already connected in TheFaithApp.
Forms may contain pastoral, child, safeguarding, health, or other sensitive
information. Collect only what your church needs, choose the correct
sensitivity, and give response access only to the people responsible for the
follow-up.
## Open Forms
1. Open the main product menu in the admin sidebar.
2. Select **Forms**.
3. Choose **All Forms**, **Responses**, or **Templates**.
Forms is a top-level product. **Donor Forms** remains inside **Outreach
Campaigns** and is a separate fundraising workflow.
## Create a Form
From **All Forms**, select **Create form** to start with an empty form, or
select **Browse templates** to start with reviewed questions and settings for a
common church workflow.
![Church form templates]()
The template catalog includes starting points for:
* General contact and connection cards.
* Baptism and membership interest.
* Volunteer interest and applications.
* Small-group interest.
* Child dedication and pastoral appointments.
* Prayer requests and praise reports.
* Event feedback and facility requests.
* Annual member-information review.
* Communication preferences and testimony submissions.
Templates are editable starting points. Review every question, privacy notice,
access choice, sensitivity, and manager before publishing.
Start with the shortest form that can support the next action. A clear form
with fewer questions is usually easier to complete and easier for staff to
follow up.
## Build the Form
The builder has three working areas: available blocks on the left, the form
canvas in the middle, and settings for the selected block on the right.
![Forms builder]()
### Add Questions
Select a block to add it to the form:
* **Short answer** for a name or brief response.
* **Long answer** for a message, story, or explanation.
* **Email address** and **Phone number** for contact details.
* **Number** and **Date** for structured values.
* **Single choice**, **Multiple choice**, and **Dropdown** for defined options.
* **Consent** for a clear acknowledgement or permission choice.
Use **Heading**, **Paragraph**, **Divider**, and **Section** to organize longer
forms without collecting an answer.
### Configure a Question
Select a question on the canvas, then review its settings. Depending on the
question type, you can:
* Change the label, help text, and placeholder.
* Make the question required.
* Set minimum or maximum limits.
* Add a custom validation message.
* Mark the answer as standard, sensitive, or restricted.
* Map an eligible answer to a member-profile field for staff review.
* Choose whether the answer may appear on the confirmation screen.
Drag blocks to reorder them, or use the up and down controls for keyboard
reordering. Duplicate a block when several questions need similar settings.
Profile mapping never silently replaces a member's saved details. A matching
response can create a proposed change for an authorized staff member to review.
## Configure Access, Privacy, and Managers
Select **Settings** in the builder.
![Form access and privacy settings]()
### Choose Who Can Open the Form
* **Public** allows anyone with the link to respond.
* **Member aware** remains public and can safely prefill verified member details
after sign-in.
* **Member only** requires a verified church member.
* **Invite only** requires a valid invitation.
* **Restricted** is intended for tightly managed or sensitive collection.
You can also decide whether a verified member may respond for themselves, an
authorized adult in their household, or a child in their household. Child
responses require guardian attestation and restricted handling.
### Review Form Settings
The settings dialog also controls:
* Overall sensitivity.
* Whether one person may respond more than once.
* Privacy and confirmation wording.
* Opening and closing times.
* A total response limit.
* Form color and the message shown after closure.
* The staff members or permission groups responsible for the form.
Restricted forms should always have explicit managers. Managers can be used to
limit response access and receive response notifications without opening the
answers to every administrator.
## Preview and Publish
Changes save to the current draft while you work.
1. Select **Preview** to review the draft without accepting a submission.
2. Check required questions, choice options, privacy wording, and confirmation
text.
3. Select **Publish** or **Publish update**.
4. Confirm the version that will become public.
Publishing creates an immutable version. Later edits create a new draft, while
the public form continues using the last published version. Select **Versions**
to review the version history.
This keeps older responses understandable after a question is renamed,
reordered, or removed.
## Share the Form
Select **Share** after publishing.
![Form sharing options]()
You can:
* Copy the public link.
* Download a QR code.
* Copy website embed code.
* Open the form in a new tab.
* Share the form through WhatsApp.
When the church has a connected custom domain, the public link, QR code,
WhatsApp link, and embed code use it automatically.
### Embed a Form on a Website
1. Copy **Website embed**.
2. Paste the complete code into a website block that accepts custom HTML or an
iframe.
3. Publish the website page.
4. Test the page on a phone and computer.
5. Submit one test response and confirm that it appears in **Responses**.
Do not change the address inside the supplied iframe. If the form is long, the
website manager can increase the iframe height while keeping the form address
unchanged.
## Check the Public Experience
Open the public link before sending it to anyone.
![Published public form]()
Confirm that:
* The church name, form title, description, and color are correct.
* Required questions and validation messages are clear.
* The privacy notice explains how the answers will be used.
* The form works at phone and desktop widths.
* The confirmation message gives the respondent a useful next step.
* Scheduled opening, closing, and response limits behave as expected.
Public submissions include duplicate and spam protections. If a connection is
interrupted, the respondent can retry safely without creating an extra response
from the same submission attempt.
## Deliver Forms in the Member App
Select **Delivery** to manage invitations, app placements, and connected
product actions.
### App Placements
A published form can be placed in a reviewed area of the member app through App
Customization. Members see the same published questions and validation rules as
the web form.
### Invitations and Reminders
Invite a member when the form should be delivered directly rather than shared
as a general public link. The delivery record shows whether the invitation was
queued, sent, opened, started, submitted, declined, or expired.
Reminders use the original delivery channel and respect the member's messaging
preferences. Avoid repeatedly reminding someone about a sensitive form.
## Review Responses
Open **Forms → Responses** for the global inbox, or open a form and choose its
responses view.
![Forms response inbox]()
Use the inbox to:
* Search respondents and answers.
* Filter by form, status, priority, owner, and submission date.
* Show current or historical answer columns.
* Choose visible columns.
* Save a useful filter as a view.
* Export the authorized view to CSV.
On phones, each response appears as a readable card with its submitted time,
status, priority, form, respondent, owner, and selected answer columns. Select a
card to open the full follow-up view. On larger screens, the same information is
available in the response table.
One row is always one submission. Repeated responses from the same person stay
separate instead of being merged.
Sensitive answers are hidden or redacted for staff who do not have permission
to see them. Export uses the same access rules as the inbox.
## Assign and Complete Follow-Up
Select a response row or mobile card to open its details.
![Response details and follow-up]()
From the response details, authorized staff can:
* Change the workflow status.
* Set normal, high, or urgent priority.
* Assign an owner and due date.
* Review the answers against the submitted version.
* Add private staff notes.
* Review the activity history.
* Review a proposed member-profile change.
* See whether a connected product action completed or needs attention.
Use the owner and due date to make the next responsibility clear. Notes and
activity are internal and are not shown to the respondent.
## Connect a Response to Other Products
Forms can start reviewed actions for supported workflows such as visitor
follow-up, member journeys, events, volunteer coordination, Community Groups,
prayer requests, or an Outreach Campaign review reference.
Configure actions from **Delivery** and review the target before activating
them. Each action is recorded against the response so staff can see whether it
completed, failed, or is waiting for review. A failed action does not remove the
original response.
Forms does not copy submissions into the legacy Donor Forms tables. A future
fundraising or donor-data transfer must be separately reviewed and explicitly
configured.
## Close, Archive, Restore, or Delete
* **Close form** stops new responses while keeping the form and its history.
* **Reopen form** returns a closed form to its published state.
* **Archive** removes the form from the active workflow without deleting its
history.
* **Restore** returns an archived form.
* **Delete draft** is available only when a draft can be safely removed.
* Moving a response to trash is recoverable by an authorized manager.
Do not delete or archive a form simply to hide sensitive data. Follow the
church's retention and safeguarding policy.
## Permissions and Privacy
Forms separates permission to build forms from permission to review responses.
Sensitive-answer access and form-manager restrictions narrow access further.
Recommended practice:
* Give form-building access only to staff who design church workflows.
* Give response access only to staff who own follow-up.
* Name managers for pastoral, child, safeguarding, or other restricted forms.
* Avoid collecting financial card data, passwords, government identifiers, or
information that belongs in a specialized product.
* Review CSV exports before sharing or storing them outside TheFaithApp.
* Confirm consent before sending reminders or starting a connected action.
## Launch Checklist
Before sharing a new form:
* [ ] Preview every question and content block.
* [ ] Confirm access mode, sensitivity, and managers.
* [ ] Review privacy and confirmation wording.
* [ ] Publish the intended version.
* [ ] Open the public or member-app form yourself.
* [ ] Test phone and desktop layouts.
* [ ] Submit a test response.
* [ ] Confirm ownership, priority, due date, and notifications.
* [ ] Confirm any connected action reaches the expected product.
* [ ] Remove or complete the test response according to your retention policy.
## Current Limitations
The current release does not yet include nested conditional logic, multi-page
branching, partial submissions, file uploads, electronic signatures, payments,
calculations, webhooks, or direct spreadsheet integrations.
Use the existing specialized Giving, Events, Prayer Requests, Visitor, and
Outreach Campaign workflows when they already match the church's need.
## Common Questions
### Are Forms and Donor Forms the same?
No. Forms is a general church workflow product. Donor Forms remains part of
Outreach Campaigns and uses separate data and fundraising workflows.
### Does editing a form change old responses?
No. Each response stays attached to the published version that was submitted.
### Can a form use our custom domain?
Yes. Once the domain is connected, generated public and embed links use it
automatically.
### Can someone submit without an account?
Yes, when the access mode is **Public** or **Member aware**. Member-only,
invite-only, and restricted forms apply their selected access checks.
### Does profile mapping immediately update a member?
No. Eligible changes are presented for authorized staff review.
### Can every administrator see sensitive answers?
No. Response permission, answer sensitivity, and form-manager restrictions are
enforced separately.
# Giving and Finance
Source: https://docs.thefaithapp.com/product/giving-and-finance
Manage donations, recurring gifts, funds, payment providers, billing plans, payment methods, and AI add-on billing in TheFaithApp.
# Giving and Finance
This guide covers the main giving and billing tools used to receive donations, manage payment setup, and control subscription-related billing in TheFaithApp.
These tools include:
* Donations
* Recurring donations
* Funds
* Public donation links
* Payment providers
* Billing plans
* Payment methods
* AI add-on billing
## Before You Start
* Sign in to your admin account.
* Open `Donations` from the left sidebar for gift activity and funds.
* Open `Settings` for payment providers, billing plans, payment methods, and AI billing.
* Some billing or payment actions depend on the payment providers already connected to your account.
## Donations Overview
Use the overview tab to monitor giving performance across the payment currencies already active in your church account.
![Donations overview]()
### What You Can Do
* Review total donations by currency
* Compare this month and this week at a glance
* See the average donation amount
* Use the overview before exporting or reviewing individual gifts
### Steps
1. Click `Donations`.
2. Stay on the `Overview` tab.
3. Review the cards for each available currency.
4. Switch to the other tabs when you need deeper detail.
## Donation Records
Use the donations list when you need to search, review, or export individual giving records.
![Donations list]()
### What You Can Do
* Search donations by donor details or reference
* Filter donations by date range
* Review gift amount, reason, method, and date
* Open an individual donation record
* Export the current results
### Steps
1. Open `Donations`.
2. Click the `Donations` tab.
3. Use search or the date range filter to narrow the list.
4. Review the donation rows.
5. Click the view icon when you need the full donation details.
6. Click `Export` when you want to download the current set of records.
### Notes
* The export action follows the filters you have applied.
* Donation rows show the payment method used for each gift.
## Public Donation Links
Use the donation link tool when you want to share a direct public giving page outside the admin dashboard.
![Donation link modal]()
### What You Can Do
* Generate a public giving link
* Copy the direct donation page URL
* Copy embed code for websites or landing pages
### Steps
1. Open `Donations`.
2. Click the `Donations` tab.
3. Click `Generate Donation Link`.
4. Copy the link or embed code you want to share.
5. Send the link to members, supporters, or website managers.
### Notes
* The generated link opens a secure public giving experience for your church.
* Use the embed option when you want the giving form placed inside another website.
## Public Giving Page
Use the public giving page when you want supporters to give through a church-branded page outside the admin dashboard.
![Public giving page]()
### What Supporters Can Do
* Choose the available payment option
* Enter a donation reason and amount
* Decide whether to cover processing fees
* Review the payment summary before continuing
### Steps
1. Generate the public donation link from `Donations`.
2. Open the link to confirm the church branding and page title.
3. Share the link with supporters.
4. Ask supporters to sign in from the public page.
5. After sign-in, choose the payment option shown on the page.
6. Enter the donation purpose and amount.
7. Turn on `Cover Processing Fees` if the supporter wants to include them.
8. Review `Payment Summary` and continue to payment.
### Notes
* The screenshot above shows the public giving form after the supporter has already signed in.
* The current public giving experience starts with sign-in before the donation form appears.
* Connected payment providers control which payment options appear after sign-in.
* If the church has set a default payment provider, supporters may see only that option instead of multiple tabs.
## Recurring Donations
Use recurring donations to review active scheduled gifts and confirm what supporters have set up to repeat automatically.
![Recurring donations]()
### What You Can Do
* Review active recurring gifts
* Search recurring donations
* See the fund, amount, frequency, method, and next payment date
* Cancel a recurring donation when needed
### Steps
1. Open `Donations`.
2. Click the `Recurring` tab.
3. Search for a donor or recurring record if needed.
4. Review the next payment date and current status.
5. Use the action menu when you need to cancel an active recurring gift.
### Notes
* The recurring table is best for finance follow-up and supporter support requests.
* Status helps your team confirm whether a recurring gift is still active.
## Funds
Use funds to control the giving categories donors can choose from.
![Funds screen]()
### What You Can Do
* Create a fund
* Add a short description
* Turn a fund on or off
* Search funds
* Edit or delete a fund
### Examples
* Building fund
* Missions
* General giving
* Youth ministry
### Steps
1. Open `Donations`.
2. Click `Funds`.
3. Click `Add Fund`.
4. Enter the fund name and optional description.
5. Save the fund.
6. Use the toggle or actions in the list when you need to update it later.
### Notes
* Active funds are available in the giving experience.
* Inactive funds can be kept for reporting history without staying visible to donors.
## Payment Providers
Use payment providers to connect the services your church will use to accept online gifts.
![Payment providers screen]()
### Available Providers
* Stripe
* Flutterwave
* PayPal
### What You Can Do
* Connect a payment provider
* Disconnect a provider
* Set the default provider
* Turn on charitable PayPal fees where applicable
* Allow donors to cover processing fees
### Steps
1. Open `Settings`.
2. Click `Payment Providers`.
3. Connect the provider you want to use.
4. Set a default provider if more than one is available.
5. Turn on `Cover Processing Fees` if your church wants to offer that option during giving.
6. Save or confirm any provider changes.
### Notes
* Stripe, Flutterwave, and PayPal can support different payment needs depending on your region and ministry setup.
* The default provider is the main option used when multiple providers are connected.
## Billing and Subscription
Use the billing page to manage your current plan, review recommended plans, and keep subscription billing organized.
![Billing and subscription screen]()
### What You Can Do
* Review your current plan
* See the recommended plan based on member count
* Compare available plans
* Add and manage payment methods
* Review billing history
### Steps
1. Open `Settings`.
2. Click `Billing & Subscription`.
3. Review the current plan summary.
4. Compare the available plans below.
5. Click `Switch Plan` when you are ready to move to a different subscription tier.
6. Review the billing history section for past charges.
### Notes
* Recommended plans are based on the member count in your church account.
* The billing page is also where AI add-on billing is managed.
## Payment Methods
Use payment methods to add the card used for subscription billing and other paid add-ons.
![Add payment method drawer]()
### What You Can Do
* Add a payment method
* Set a default card
* Remove a payment method when it is no longer needed
### Steps
1. Open `Settings`.
2. Click `Billing & Subscription`.
3. In `Payment Methods`, click `Add Payment Method`.
4. Enter the cardholder name and card details.
5. Save the payment method.
### Notes
* Add a payment method before activating paid add-ons or switching to paid plans.
* The billing page uses the saved payment methods section for subscription charging.
## AI Add-On Billing
Use the AI section on the billing page to manage access to the Digital Ministry Assistant add-on.
### What You Can Do
* Review free AI replies remaining
* Activate the AI add-on
* See included, used, and remaining usage
* Cancel the add-on when needed
### Steps
1. Open `Settings`.
2. Click `Billing & Subscription`.
3. Find the `Digital Ministry Assistant` section.
4. Review the current status and usage totals.
5. Add a payment method first if required.
6. Click `Activate AI Add-on` when you are ready to continue with paid AI usage.
### Notes
* The billing panel shows whether the AI add-on is active, inactive, past due, or canceled.
* Free usage can run out before activation is required, depending on the account state.
# Marketing
Source: https://docs.thefaithapp.com/product/marketing
Manage marketing dashboards, Mailgun, Twilio, email campaigns, email templates, subscribers, and SMS outreach in TheFaithApp.
# Marketing
This guide covers the marketing tools used to manage email and SMS communication in TheFaithApp.
These tools include:
* Marketing dashboard
* Integrations
* Mailgun
* Twilio
* Email campaigns
* Email templates
* Email subscribers
* SMS campaigns
* SMS templates
* SMS subscribers
## Before You Start
* Sign in to your admin account.
* Open `Marketing` from the six-product sidebar, then choose `Dashboard`, `Email Marketing`, `SMS Marketing`, or `Integrations`.
* Use `Integrations` before building campaigns if your providers are not set up yet.
* New accounts may show empty states until your first template, subscriber list, or campaign is added.
## Marketing Dashboard
Use the dashboard to monitor the overall health of your email and SMS activity from one place.
![Marketing dashboard]()
### What You Can Do
* Review email campaign totals
* Review SMS campaign totals
* Check open, click, and delivery rates
* Monitor template and subscriber totals
* See scheduled campaign totals at a glance
### Steps
1. Open `Marketing`.
2. Stay on `Dashboard`.
3. Review the summary cards for email, SMS, templates, and subscribers.
4. Open the related marketing section when you want to take action on a specific area.
### Notes
* The dashboard is the best starting point for a quick daily review.
* Empty cards usually mean this area has not been configured or used yet.
## Integrations
Use integrations to connect the providers that power your email and SMS delivery.
![Marketing integrations]()
### What You Can Do
* Open SMTP setup
* Configure Mailgun
* Configure Twilio
* Review which providers are already active
### Steps
1. Open `Marketing`.
2. Click `Integrations`.
3. Review the email and SMS provider cards.
4. Click `Configure` on the provider you want to update.
### Notes
* `SMTP Configuration` opens the general settings area for SMTP setup.
* Mailgun and Twilio can both be managed directly from this screen.
## Mailgun
Use the Mailgun drawer when your team wants Mailgun to handle email delivery.
![Mailgun configuration drawer]()
### What You Can Do
* Enter your Mailgun API key
* Add the verified Mailgun domain
* Choose the Mailgun region
* Turn Mailgun on or off
* Set Mailgun as the default email provider
### Steps
1. Open `Marketing`.
2. Click `Integrations`.
3. In the `Mailgun Integration` card, click `Configure`.
4. Enter the provider details.
5. Turn on Mailgun if you want to use it for sending.
6. Save the settings.
### Notes
* Use the region that matches your Mailgun account.
* Set Mailgun as default only if it should be the main email sending service for your church.
## Twilio
Use the Twilio drawer when your team wants Twilio to handle SMS delivery.
![Twilio configuration drawer]()
### What You Can Do
* Enter the Twilio account SID
* Enter the auth token
* Add the sending phone number
* Turn Twilio on or off
* Set Twilio as the default SMS provider
### Steps
1. Open `Marketing`.
2. Click `Integrations`.
3. In the `Twilio Configuration` card, click `Configure`.
4. Enter the provider details.
5. Turn on Twilio when you are ready to send SMS campaigns.
6. Save the settings.
### Notes
* The phone number should be the number your church will send SMS from.
* Set Twilio as default if it should be the main SMS provider for your account.
## Email Campaigns
Use email campaigns to plan and manage email communication for members and subscribers.
![Email campaigns screen]()
### What You Can Do
* Search campaigns
* Filter by status
* Create a new campaign
* Review empty-state prompts when no campaigns exist yet
### Steps
1. Open `Marketing`.
2. Expand `Email Marketing`.
3. Click `Email Campaigns`.
4. Use search or status filters to narrow the list.
5. Click `Create Campaign` when you want to start a new email campaign.
### Notes
* This page is the main workspace for reviewing campaign status.
* New accounts will usually start with an empty state here.
## Creating an Email Campaign
Use the create drawer when you want to start a guided email campaign setup.
![Create email campaign drawer]()
### What You Can Do
* Enter campaign details
* Move through the guided setup steps
* Choose recipients
* Decide whether to send now or schedule later
### Steps
1. Open `Email Campaigns`.
2. Click `Create Campaign`.
3. Enter the campaign name, sender name, and sender email.
4. Continue through the content, recipients, schedule, and review steps.
5. Save or continue based on the campaign flow shown in the drawer.
### Notes
* The campaign builder uses a step-by-step flow to keep setup organized.
* Template loading and recipient totals are still limited in the current build, so treat this flow as in progress.
## Email Templates
Use email templates to prepare reusable layouts and messaging before creating campaigns.
![Email templates screen]()
### What You Can Do
* Create a template
* Filter templates by category
* Edit a template
* Duplicate a template
* Delete a template
### Steps
1. Open `Marketing`.
2. Expand `Email Marketing`.
3. Click `Email Templates`.
4. Use the category filter if you want to narrow the list.
5. Click `Create Template` to add a new reusable template.
### Notes
* Templates are helpful when your team sends similar messages often.
* Keep template names clear so campaign builders can choose the right one quickly.
## Creating an Email Template
Use the create template drawer when you want to prepare the structure of a new email before sending campaigns.
![Create email template drawer]()
### What You Can Do
* Add a template name
* Choose a category
* Add the subject line
* Add optional preview text
* Move into the design tab for the email layout
### Steps
1. Open `Email Templates`.
2. Click `Create Template`.
3. Enter the basic template details.
4. Open the `Email Design` tab when you are ready to build the layout.
5. Save the template.
### Notes
* Preview text helps members understand the message before opening the email.
* Use categories to keep welcome emails, announcements, and follow-up templates organized.
## Email Subscribers
Use email subscribers to manage who can receive email communication from your church.
![Email subscribers screen]()
### What You Can Do
* Search subscribers
* Filter by status
* Filter by source
* Sync members into the subscriber list
* Import subscribers from CSV
* Unsubscribe, resubscribe, or delete subscribers
* Bulk unsubscribe or bulk delete selected subscribers
### Steps
1. Open `Marketing`.
2. Expand `Email Marketing`.
3. Click `Email Subscribers`.
4. Use search or filters to review the list.
5. Click `Sync Members` to pull member records into the subscriber list.
6. Click `Import Subscribers` if you want to upload a CSV file.
### Notes
* Source labels help your team tell whether a subscriber came from members, imports, or manual entry.
* Syncing members is useful after major membership updates.
## Importing Email Subscribers
Use the import drawer when you already have a CSV file of contacts to add.
![Import email subscribers drawer]()
### What You Can Do
* Upload a CSV file
* Confirm whether the first row contains headers
* Import a batch of contacts in one step
### Steps
1. Open `Email Subscribers`.
2. Click `Import Subscribers`.
3. Select the CSV file.
4. Confirm whether the first row contains headers.
5. Click `Import Subscribers`.
### Notes
* CSV import is the fastest option when you already have contacts outside the platform.
## SMS Campaigns
Use SMS campaigns to prepare text message communication for members or subscriber groups.
![SMS campaigns screen]()
### What You Can Do
* Search campaigns
* Filter by status
* Create a new SMS campaign
* Review the campaign list from one place
### Steps
1. Open `Marketing`.
2. Expand `SMS Marketing`.
3. Click `SMS Campaigns`.
4. Use search or status filters when needed.
5. Click `Create Campaign` to start a new SMS campaign.
### Notes
* SMS campaigns use a guided flow similar to email campaigns.
## Creating an SMS Campaign
Use the create drawer when you want to build an SMS campaign step by step.
![Create SMS campaign drawer]()
### What You Can Do
* Enter campaign details
* Choose a saved SMS template
* Review recipient totals
* Schedule the campaign or send it immediately
### Steps
1. Open `SMS Campaigns`.
2. Click `Create Campaign`.
3. Enter the campaign name and optional sender ID.
4. Continue through message, recipients, schedule, and review.
5. Complete the campaign setup from the final step.
### Notes
* The SMS builder shows the campaign process in five clear steps.
* Recipient totals are calculated as you choose the audience.
## SMS Templates
Use SMS templates to save reusable message formats for future campaigns.
![SMS templates screen]()
### What You Can Do
* Create a template
* Filter by category
* Edit a template
* Duplicate a template
* Delete a template
### Steps
1. Open `Marketing`.
2. Expand `SMS Marketing`.
3. Click `SMS Templates`.
4. Use the category filter when needed.
5. Click `Create Template` to add a reusable message.
### Notes
* SMS templates help teams move faster when they send recurring reminders or announcements.
## Creating an SMS Template
Use the create drawer when you want to save a new reusable SMS message.
![Create SMS template drawer]()
### What You Can Do
* Add a template name
* Choose a category
* Write the SMS message
* Set the template active or inactive
### Steps
1. Open `SMS Templates`.
2. Click `Create Template`.
3. Enter the template name and category.
4. Write the message content.
5. Save the template.
### Notes
* Keep templates short and clear so they fit SMS comfortably.
## SMS Subscribers
Use SMS subscribers to manage the people who can receive text message communication from your church.
![SMS subscribers screen]()
### What You Can Do
* Search subscribers
* Filter by status
* Filter by source
* Send opt-in SMS to all pending contacts
* Sync members into the SMS list
* Import subscribers from CSV
* Send individual opt-in messages
* Confirm opt-in
* Unsubscribe or delete subscribers
### Steps
1. Open `Marketing`.
2. Expand `SMS Marketing`.
3. Click `SMS Subscribers`.
4. Use search or filters to review the list.
5. Click `Send Opt-In SMS (All Pending)` when you want to follow up with pending contacts.
6. Use `Sync Members` or `Import Subscribers` when you need to add more contacts.
### Notes
* SMS subscriber status is especially important because opt-in confirmation affects who can receive future messages.
## Importing SMS Subscribers
Use the import drawer when you already have a CSV file of phone contacts to add.
![Import SMS subscribers drawer]()
### What You Can Do
* Upload a CSV file
* Confirm whether the first row contains headers
* Import a batch of SMS contacts
### Steps
1. Open `SMS Subscribers`.
2. Click `Import Subscribers`.
3. Select the CSV file.
4. Confirm the header option.
5. Click `Import Subscribers`.
### Notes
* Import is useful when your church already has a separate SMS contact list.
## Current Product Notes
* `SMTP Configuration` is linked from `Marketing > Integrations`, but the actual setup screen opens in the general `Settings` area.
* The email campaign builder is visible and usable as a guided workflow, but template loading and recipient totals are still limited in the current build.
* Email campaign card `View` and `Edit` actions are not fully available yet in the current build.
# Member Connections and Community Groups
Source: https://docs.thefaithapp.com/product/member-connections
Help members connect with campuses, ministries, and community groups while keeping every relationship manageable and privacy-aware.
Member Connections gives people a clear picture of where they belong in your
church. Members can manage their campuses, ministries, and community groups
from the mobile app, while staff can review requests and keep those
relationships accurate from the web dashboard.
## For members
Open **My Connections** in the mobile app to see:
* Your primary and additional campuses.
* Ministries where you participate, volunteer, or lead.
* Community groups you have joined or asked to join.
* Connections that are still waiting for approval.
From this screen, you can request a campus or ministry connection, choose
whether an active connection appears in the Member Directory, or leave a
connection you no longer participate in.
## Open Community and find a group
Community Groups are designed for members and are separate from the permission
groups used to manage dashboard administrators.
To find a group:
1. Open **Community** from **Connect** in the mobile app.
2. Use **My Groups** to return to an active or pending group, or select
**Discover** to search and filter available groups.
3. Open a group to review its campus, schedule, meeting location, and joining
policy.
4. Select **Join group**.
Open groups add you immediately. Groups that require approval show a pending
status until a leader or staff member responds. Invite-only groups cannot be
joined without an invitation.
## Collaborate in a group
After joining a group, members can read announcements, participate in the
discussion feed, open shared study guides, and enter any chat channel connected
to the group. Discussion channels let active members converse. Announcement
channels are read-only for ordinary members; group leaders and staff can post.
Group leaders can also publish feed announcements and study guides, record
attendance, and keep leader-only notes.
Chat access follows Community Group membership. A member receives access after
joining or approval, and loses access after leaving or removal. Members keep
using the normal chat experience, including reactions, replies, attachments,
read states, and mute controls.
## Manage connections as staff
From the **Members** area of the web dashboard, staff can:
* Assign campuses, ministries, and community groups to a member.
* Choose a member's primary campus and role in each connection.
* Review pending campus, ministry, and community-group requests.
* Approve or decline requests.
* Create and maintain member-facing community groups.
* Publish group announcements and study guides.
* Review discussion activity, attendance records, and leader-only notes.
* Open **Chat channels** for a Community Group and create its discussion or
announcement channel.
* Select **Reconcile access** if channel participation ever falls out of sync
with active group membership.
* Decide whether member campus and ministry requests require approval.
Connections assigned by staff become active immediately.
The **Chat channels** action is available to main administrators and staff with
Community Group management permission. Each group can have one discussion
channel and one announcement channel.
Churches preparing practical-help requests can also use the permission-gated
[Needs & Offers moderation guide](/product/needs-and-offers) to configure safe
audiences, review posts, coordinate follow-up, and resolve reports before the
member board is enabled.
## Use connections in the Member Directory
Members can filter the directory by:
* Campus
* Ministry
* Community group
* General location
Only active connections that a member has chosen to show are used in directory
results. Location filtering uses visible city, state, or country information;
it never exposes a private street address.
## Privacy and safety
* A member controls whether each connection appears in the directory.
* Pending, declined, and inactive connections are not shown in directory
results.
* Members only see information from their own church.
* Existing directory protections for children and private profile fields still
apply.
* Participation may suggest a useful connection in a future release, but the
app never silently connects a member based on inferred activity.
# Member Data Hygiene and Migration
Source: https://docs.thefaithapp.com/product/member-data-hygiene
Keep member records accurate, privacy-aware, and ready for directory use.
Member Data Hygiene is a staff workflow in **Members → Data hygiene**. Use it
before publishing a directory or after importing records from another church
management system.
## Review the data-quality summary
The summary highlights duplicate records, incomplete profiles, directory
consent that needs review, address values that can be normalized, and the
quality of the latest import.
## Resolve duplicate records
Open the duplicate report to compare records that match on email, phone, or a
name-and-city combination. Choose the record to keep and confirm the merge.
The kept record receives missing values from the duplicate. The duplicate is
archived safely, so the action does not permanently erase the record.
## Standardize addresses
Preview normalized city, state, country, and postal-code values first. Apply
the changes only after the preview looks correct.
## Review missing fields and consent
Use the missing-profile and consent counts to contact members or update records
before they appear in the directory. Directory visibility and per-field privacy
remain controlled by the member and the church's directory settings.
## Migrate an existing church database
Use the guided CSV import and select the source format for an export from
Planning Center, Breeze, Subsplash, or Tithe.ly. Map the columns, run the
import, and review accepted, failed, and skipped rows in the import quality
report before repeating an import.
The migration workflow uses exported files; it does not connect directly to a
third-party provider account.
# Member Directory
Source: https://docs.thefaithapp.com/product/member-directory
A privacy-first church directory where members find and connect with each other, and staff manage households, approvals, and visibility.
The Member Directory helps people in your church find and connect with one another, while giving every member control over what they share.
## For members
From the mobile app, members can:
* **Browse and search** the church directory by name.
* **Open a member's profile** to see what that person has chosen to share — including their active connections and any contact details, location, birthday, or household they've made visible.
* **View a household** to see the family together.
* **See upcoming birthdays** — a "Birthdays this week" view highlights celebrations among visible members.
* **Use the directory offline** — the last directory list a member loaded is shown even without a connection, with a clear offline indicator until it refreshes.
* **Control their own privacy** from the directory's privacy screen:
* A master "Show me in the directory" switch.
* Whole-profile visibility: everyone in the church, leaders only, or hidden.
* Per-field visibility for email, phone, address, birthday, and household.
* **Update their own profile** from the edit-profile screen:
* **Set a profile photo** by choosing an image from their library or taking a new one.
* **See their household** (read-only — households are managed by staff).
* When the church requires approval for sensitive changes, get a clear **"submitted for approval"** confirmation listing the fields awaiting staff review, while non-sensitive changes save immediately.
Contact details are **private by default**. A field only appears to others once the member (or the church default) makes it visible. The member's privacy controls also live on the profile page, so they're easy to find.
## For staff and admins
From the web dashboard, under **Members**, staff can:
* **Directory Settings** — turn the directory on or off, choose default field visibility, show or hide member photos, and decide whether to include children.
* **Households** — create households and add members by searching for them by name or email (members already in the household are filtered out), and set each member's role, so families appear together.
* **Change Requests** — review and approve or reject sensitive profile edits (name, contact, birth date) when approval is required. This is opt-in per church.
* **Leaders** — designate directory leaders, who can see "leaders only" fields.
* **Birthday & anniversary reminders** — opt in to a daily digest of today's birthdays and anniversaries, pushed to directory leaders.
## Privacy and safety
* Children are excluded from the member-facing directory by default.
* Privacy is enforced for every request — a member only ever receives the fields they're permitted to see.
* Members of one church can never see members of another church.
## Current product notes
* The member-facing directory, household view, and privacy controls live in the mobile app.
* Directory settings, household management, the change-request approval queue, and leader designation live in the web dashboard under Members.
* Campus, ministry, Community Group, and privacy-safe location filters are part
of [Member Connections](/product/member-connections).
# Use and moderate Needs & Offers
Source: https://docs.thefaithapp.com/product/needs-and-offers
Share practical needs and offers safely in the mobile app, then review and coordinate them from the web dashboard.
Needs & Offers gives adult members a moderated place to request or offer
practical help without publishing personal contact details. The board is
disabled by default so staff can review its safeguards before members begin
using it.
## Find the member board
In the mobile app, open **Connect**, select **Community**, then choose
**Needs & Offers**. This option appears only after the church enables the board
and the signed-in member is eligible to use it.
Use the top filters to switch between needs and offers or narrow the board by
category, campus, Community Group, audience, or status. Each card shows only a
safe summary, approximate audience, published age, and expiry information.
![Needs & Offers member board]()
## Publish a need or offer
Select **Post**, choose whether you need help or can offer it, and complete the
short form. You can choose an allowed audience, such as your campus, Community
Group, or leaders only.
Keep phone numbers, email addresses, exact street addresses, and other direct
contact details out of the title and description. Responses begin privately in
the app. Depending on church settings and category, a post may appear
immediately or be sent to staff for review.
### Donation drives
Choose **Donation drive** when the church is collecting items or funds for a
shared response. Staff review the post and connect it to an active Outreach
Campaign before publishing it.
Once connected, the post shows **View campaign & contribute**. This opens the
church's existing campaign page with the current requested items, payment
options, delivery details, and progress. Members do not need to choose between
two different donation forms.
### Employment help
Choose **Employment information** for a job opening, a request for work,
career mentoring, or résumé and interview help. The form also records whether
the help is on-site, remote, or hybrid and whether it is one-time, short-term,
or ongoing.
Employment posts use the same reviewed Needs & Offers workflow. The app does
not score or automatically match members, and contact details remain outside
the public post. The saved help type, work mode, and time commitment remain
visible on the member post and in the staff review drawer.
### Future community pilots
When your church opens relational research, the mobile **Community** screen
shows **Help shape future community support**. Open it to privately select
future ideas you may consider, such as skills sharing, recurring rides,
intergenerational connections, nearby practical help, or newcomer connections.
This records research interest only. It does not create a match,
recommendation, chat, or relationship-risk score. Your church sees only
combined counts, and small counts are hidden. You can update your choices or
withdraw at any time, including after the church pauses new interest.
## Borrow or lend a community resource
When your church enables **Community resources**, open **Community** and select
the resource card. Use **Browse** to find reviewed lending items and
staff-coordinated medical equipment. Select **Request item** and add an optional
private note without contact details.
Use **My items** to lend an item you own. Staff review every listing before it
appears. You can approve or decline a request, mark an approved loan checked
out, and record its return. **My loans** shows your requests, due dates,
overdue state, cancellations, and returns.
Medical equipment is always reviewed and coordinated by staff. Members never
see its exact storage location, and only staff approve, check out, or return a
medical-equipment loan. A borrower sees staff-coordination guidance instead of
a return action.
## Respond and coordinate privately
Open a post and select **Respond privately**. The response is visible to the
post author and authorized staff, not to the public board.
The author can accept or decline responses. Once a response is accepted, both
members can continue in a private in-app conversation. The author can then mark
the post fulfilled or close it for another reason.
Open **My activity** to review your posts and responses. From there you can
edit or extend an eligible post, mark it fulfilled, close it, withdraw a
response, or return to an accepted private conversation.
Use **Report** on a post when staff should review a safety or conduct concern.
Needs & Offers is not an emergency service; contact local emergency services
or a trusted church leader when immediate help is needed.
## Set up the board
Open **Members**, select **Needs & Offers**, then open **Settings**.
Before enabling the board, review:
* Whether every post must be approved before publishing.
* Whether church-wide posts are allowed or audiences stay limited to a campus,
Community Group, or leaders.
* Whether an author may choose to show their name.
* Which categories are enabled.
* Which categories always require review.
* Default and maximum expiry periods for each category.
* Whether the separate research-interest registry is open to eligible adult
members.
* Whether the reviewed Community resource library is available to eligible
adult members.
The safest launch settings are already selected: the board is off, every post
requires review, church-wide visibility is off, and author names are hidden.
Sensitive categories remain leaders-only and always require review.
After staff confirm those safeguards, this is also the screen where they can
enable or pause the member board.
![Needs & Offers safeguards]()
## Review relational research readiness
Open **Research pilots** to see voluntary interest before designing any future
pilot. This page never lists participating members. It shows combined counts
only and displays **fewer than 5** when a church or research area has fewer than five
active opt-ins.
The page also keeps the research boundaries visible: no automatic matching,
no member identities, no precise location, no relationship-risk scores, adult
participation only, and withdrawal at any time. Interest is discovery input,
not approval to launch a matcher. Complete pastoral, safeguarding, fairness,
and explainability review before proposing a pilot.
## Review a post
Staff with Needs & Offers view permission can open the moderation queue and
review a post's requested audience, safe location, author context, responses,
reports, and audit history.
Staff with moderation permission can:
* Approve and publish a pending post.
* Ask the author for a safer edit without rewriting their words.
* Restrict a post to leaders only.
* Assign a staff coordinator.
* Reject or close a post with a recorded reason.
For a donation drive, staff who also have Outreach Campaign access select an
active campaign in the **Donation coordination** section. The post cannot be
approved until a campaign that accepts items or cash is linked. Use **Manage
campaign** to update requested items, payment options, delivery instructions,
and pledge progress in the existing Outreach Campaign workflow.
## Coordinate an assigned post
A staff member assigned to a post gets an **Assigned Needs & Offers** entry
even when they do not have the board-wide view or moderation
permissions. It shows only the assigned post and its private responses. The
coordinator can accept or decline a response, mark the post fulfilled, or close
it with a reason.
Assignment does not open the moderation queue, reports, audit history,
settings, staff directory, or any other post. Reassigning the post removes the
previous coordinator's access immediately.
Time-sensitive and sensitive-category posts show a pastoral review warning.
Needs & Offers is not an emergency service; use your church's existing
safeguarding and emergency procedures when urgent follow-up is required.
## Handle reports
Open **Reports** to review member safety concerns. Reporter identity is visible
only inside the permission-gated staff queue and is never shown to a post
author or other members.
Three reports from different members within 24 hours pause an open post for
review by default. Staff can resolve or dismiss a report with an optional note.
## Manage resources and ministry chats
Open **Resources** in Needs & Offers to review member lending items, add
church-managed medical equipment, approve or restrict listings, and coordinate
loan approval, checkout, overdue, and return states. Resource access reuses the
Needs & Offers view and moderation permissions.
Open **Volunteers → Ministries** and select the chat action for a ministry to
create one private discussion and one leader-posting announcement channel.
Active ministry membership controls chat access, ministry leaders become chat
moderators, and **Sync membership** reconciles any drift.
## Choose communication preferences
From the mobile Notifications screen, open **Communication preferences**.
Members can schedule recurring quiet hours by local time and weekday. The app
automatically starts with the church's time zone, and a dropdown of valid time
zones is available when it needs to be changed. Members can then enable or
pause push notifications for direct messages, ministries, Community Groups,
and Needs & Offers.
Inside an individual chat, choose **All messages**, **Mentions only**, or
**None**. The server applies quiet hours, topics, and the channel choice before
sending push notifications. Messages and in-app activity remain available.
## Automatic expiry and private contact
Posts expire automatically according to their category. The author receives a
generic in-app update that does not repeat the post title, description,
location, or other sensitive details.
Phone numbers, email addresses, and exact street addresses are rejected from
post content. The offline mobile board stores only safe card summaries and does
not store post descriptions, author details, response notes, or contact data.
Responses begin privately inside the app.
## Staff permissions
Needs & Offers uses three separate permissions:
* **View Needs & Offers** reads the moderation and reports queues.
* **Moderate Needs & Offers** approves, restricts, assigns, rejects, closes,
and resolves reports. A moderator also needs view permission.
* **Configure Needs & Offers** changes the board's church-level settings,
controls whether research interest is open, and reads thresholded research
readiness. It does not expose participant identities.
Being assigned as a coordinator is post-specific access, not a fourth broad
permission. It provides only the assigned coordination actions described
above.
Main administrators receive all three permissions automatically.
Linking or changing a donation drive's campaign additionally requires the
existing **Outreach Campaigns** permission. Assigned coordinators can see the
linked campaign summary but cannot change it unless they also have the full
view, moderation, and Outreach Campaign permissions.
Report access follows the existing **View Needs & Offers** permission; a second
recipient-role system is not created. Community Group chat provisioning also
stays in the existing **Chat channels** action for each group.
## Launch or pause the board
Use a small canary group of churches before enabling Needs & Offers broadly.
For each church, leave the board disabled while staff confirm permissions,
categories, review rules, audience choices, expiry periods, and safeguarding
ownership. Then enable it from **Members → Needs & Offers → Settings**.
Monitor the moderation queue, report rate, time to first response, expired
posts, and private-chat handoffs during the canary. These measures are for
workflow health and must not become public member rankings or generosity
scores.
To pause a church immediately, turn the board off in the same Settings screen.
Members will no longer see the board or be able to read or change posts. The
existing posts, reports, decisions, and audit history remain available for a
safe investigation and later re-enable; do not delete them as part of a pause.
The research-interest registry has its own setting. Leave it off until a named
pastoral owner approves the research notice. Turning it off pauses new and
updated interest while keeping withdrawal available to anyone who previously
opted in.
# New Visitor Journey
Source: https://docs.thefaithapp.com/product/new-visitor-journey
Set up a welcoming guest page, collect Connect Cards, and coordinate thoughtful follow-up from one Visitor Inbox.
The New Visitor Journey gives first-time guests a simple way to learn what to
expect, plan a visit, or ask for help. Guests can use the public pages without
creating an account or signing in.
When a guest submits a form, the response appears in **Visitor Inbox** so your
team can assign an owner, follow up, and keep the full story in one place.
## Before You Start
Make sure you have:
* Access to **Branches** and **Visitor Inbox**.
* At least one branch with its address and active gathering times added.
* Arrival, parking, kids, accessibility, and welcome-desk information for each
branch.
* A public welcome image address if you want to show a custom photo.
* A church-owned Handwrytten account if your team wants to send physical
welcome cards.
Read the public page as if you were arriving at your church for the first
time. Details that feel obvious to regular members can be very helpful to a
new guest.
## 1. Prepare Each Branch
The public guest pages use the information saved on the selected branch.
![Visit information in the branch editor]()
### Steps
1. Open **Branches**.
2. Find the branch you want to update and select its edit button.
3. Scroll to **Visit Information**.
4. Add clear arrival, parking, kids, accessibility, welcome-desk, public
contact, and map information.
5. Paste a public **Welcome image URL** if you want to show a custom photo.
6. Choose a **Page theme color** that works with your church branding.
7. Select **Update Branch**.
### Welcome Image Tips
* Use a bright, welcoming photo of the church, entrance, or community.
* The image must already be online and have a public address beginning with
`https://`.
* If you do not manage your church website, ask the person who does to give you
the image address.
* Do not use a private photo link that requires someone to sign in.
Do not place private staff details or sensitive pastoral information on the
public page. Only add contact information that the church is comfortable
sharing publicly.
## 2. Preview the Guest Experience
Use the public page to check exactly what a guest will see before you share it.
![Public Plan a Visit page]()
Check that:
* The church name, photo, and theme color look correct.
* The address, arrival, parking, kids, and accessibility details are easy to
understand.
* The correct branches and gathering times appear.
* The form works well on both a phone and a computer.
* The contact-permission choices are clear.
Guests do not need an account. They can complete the form directly from the
public page, even though a **Sign In** option may also appear in the header.
## 3. Share or Embed the Pages
Open **Visitor Inbox** and select **Generate visitor links**.
![Visitor page links and embed code]()
You will see two guest pages:
* **Plan a Visit** helps someone prepare for a service and choose a branch,
gathering, and planned visit date.
* **Connect Card** lets someone ask a question, request support, show interest
in a next step, or request a pastor conversation.
### Share a Direct Link
1. Select the copy button beside the page you want to share.
2. Paste the link into an email, message, social profile, QR code, or website
button.
3. Open the link yourself once to confirm that it works.
### Place a Form on Your Website
1. Copy the **Embed code** for the page you want.
2. Paste it into the part of your website that accepts custom HTML or embed
code.
3. Open the website on a phone and computer to check the size and spacing.
If you do not manage the website, send the complete embed code to the person
who does. They should paste it as supplied rather than changing the link
inside it.
## 4. Understand the Connect Card
The Connect Card is designed to feel welcoming and optional. Only a name and
one way to reach the guest are required.
![Public Connect Card]()
A guest can:
* Select an area of interest.
* Add a question or message.
* Choose a preferred contact method.
* Allow email, text, or phone contact separately.
* Ask for a pastor conversation.
* Choose **No follow-up** when they do not want to be contacted.
Asking for a pastor conversation does not automatically give permission for
marketing messages.
## 5. Work From Visitor Inbox
Every submitted Plan a Visit form or Connect Card appears in **Visitor Inbox**.
![Visitor Inbox]()
Use the search box and filters to find someone by:
* Name, email address, or phone number.
* Journey status.
* Branch, follow-up owner, or form source.
* Submission date.
* Pastor-call request.
* Overdue follow-up.
The cards at the top give your team a quick view of new visitors, planned
visits, completed visits, pastor-call requests, and overdue work.
### Helpful Terms
* **Status** shows where the guest is in the journey, such as new, visit
planned, visited, or following up.
* **Owner** is the staff member responsible for the next personal response.
* **Overdue** means a staff follow-up task has passed its due date and is not
complete.
## 6. Follow Up With One Visitor
Select a visitor row to open their details.
The visitor drawer is organized into four tabs:
* **Overview** shows contact details, journey status, follow-up ownership,
recommended next steps, visit plans, and contact permission.
* **Follow-up** contains staff tasks and private notes.
* **Handwrytten** contains the church's welcome-card workflow and order history.
* **Timeline** shows the complete chronological visitor journey.
Before contacting someone, check both their preferred method and the permission
for that exact channel. Permission to email does not also give permission to
text or call.
## 7. Configure the Follow-Up Sequence
Select **Follow-up settings** in **Visitor Inbox** to decide what should happen
after a new form arrives.
![Visitor follow-up sequence settings]()
You can configure:
* A default follow-up owner.
* A personal welcome task and its due time.
* Overdue reminders.
* An immediate pastor-call task when requested.
* Confirmation email and text wording.
* An optional invitation to an upcoming newcomer event.
Select **Save sequence** after making changes.
Automated email and text messages are only sent when that delivery service is
configured and the guest allowed that exact contact channel. Permission is
checked again when the message is about to be sent.
Automation helps the team remember the next action. Personal and pastoral
follow-up still belongs to the assigned staff member.
## 8. Send a Handwrytten Welcome Card
Churches with their own Handwrytten account can prepare and track a physical
card from the visitor details. Handwrytten bills the connected church account;
TheFaithApp never stores the payment card number.
### Connect the Church Account
1. Open **Settings**, then **Integrations**.
2. Select the **Handwrytten** card to open its setup drawer.
3. Copy an API key from the church's Handwrytten Integrations page.
4. Paste the key into TheFaithApp and select **Connect and test**.
5. Confirm the account mode and default return address shown in TheFaithApp.
6. If the account has no default return address, either choose one of its
existing saved addresses or enter a new one.
7. Read and select the confirmation checkbox before making that address the
account default.
Test mode does not print or mail the card, although Handwrytten may place a
temporary payment authorization. Live mode charges the church's Handwrytten
account and sends the physical card.
TheFaithApp does not silently change a Handwrytten return address. Choosing a
saved address or entering a new one requires an explicit confirmation because
the action updates the connected Handwrytten account and can affect other
services that use it. A newly entered address is added to Handwrytten and made
the account default.
### Prepare and Approve a Card
1. Open the visitor in **Visitor Inbox**.
2. Open the **Handwrytten** tab and select **Send a card**.
3. Confirm the visitor's postal address and record how they gave permission to
receive physical mail.
4. Choose a card design and handwriting style from the connected Handwrytten
account.
5. Review the message, closing, and read-only Handwrytten return address.
6. Review the completed card before selecting **Submit test card** or the live
mailing action.
The saved design, message, and handwriting style can be reused as the church's
visitor-card defaults. The return address always comes from the connected
Handwrytten account.
Never send a physical card without the visitor's current permission. In live
mode, check the recipient, address, message, and charge warning carefully
before approving the order.
### Track the Result
The visitor details show each draft or order with its test/live state, current
status, message preview, and any provider error. Submitted orders can be
refreshed, and cancellation appears only when the order can still be canceled.
If Handwrytten definitely rejects an order, correct the account or card details
and create a new draft. If the result says it needs review, do not submit it
again until the Handwrytten order history has been checked.
## 9. Link a Visitor to the Member Directory
When the relationship is ready, open the visitor and select **Link existing
member** or **Convert to member**.
The app shows possible records with the exact same email address or phone
number so staff can review them first. It never merges those records
automatically.
The original visit, notes, tasks, and timeline stay in Visitor Inbox. Contact
permission is not copied to the member record, and converting a visitor does
not send account credentials.
## Recommended Next Steps
The guest confirmation page and visitor details only show actions that are
available for that church and person. After a visitor is linked to a member,
the member Home screen can also recommend useful actions such as:
* Choose a branch.
* Join an active Community Group.
* Explore an upcoming event.
* Find an active serving opportunity.
* Request prayer.
* Continue a requested pastor conversation.
Membership classes, baptism, and Bible-plan recommendations stay hidden until
those experiences are available and configured.
## Before You Share the Pages
* Preview both **Plan a Visit** and **Connect Card**.
* Test the pages on a phone and computer.
* Confirm every branch has current public information and gathering times.
* Submit one test response and confirm it appears in **Visitor Inbox**.
* Confirm the correct staff member receives ownership.
* Review the confirmation wording and contact permission.
* Close the test visitor and complete its test tasks when testing is finished.
## Common Questions
### Does a guest need to create an account?
No. The Plan a Visit and Connect Card forms work without sign-in.
### Does submitting a form create a member record?
No. It creates a visitor record. Staff choose later whether to link or convert
the visitor to a member.
### Can both forms be placed on our church website?
Yes. Use the embed code shown under **Generate visitor links**, or share the
direct links from buttons on your website.
### What happens if two records have the same email address or phone number?
The app shows a possible match for staff to review. It does not automatically
merge or delete either record.
### Can the system send a message without permission?
Automated messages only use a channel the guest specifically allowed. Staff
should also review and respect the guest's choices before making personal
contact.
## Current Product Notes
* Newcomer invitations currently use an existing upcoming Event while a
dedicated Classes experience is not yet available.
* Physical card artwork is created and managed in Handwrytten. TheFaithApp
provides selection, approval, submission, and visitor-history tracking.
* Handwrytten test mode still requires a payment method that can accept a
temporary authorization, even though the card is not mailed or charged.
# Outreach and Donor Management
Source: https://docs.thefaithapp.com/product/outreach-and-donor-management
Create outreach campaigns, review campaign donations, manage donors, work with donor forms, and share public campaign pages in TheFaithApp.
# Outreach and Donor Management
This guide covers the outreach tools used to run giving campaigns, manage donor information, and share campaign pages with supporters.
These tools include:
* Outreach campaigns
* Campaign items
* Campaign donations
* Donor directory
* Donor details
* Donor forms
* Campaign analytics
* Public campaign pages
## Before You Start
* Sign in to your admin account.
* Open `Outreach Campaigns` from the six-product sidebar, then choose the campaign, analytics, donations, or donor-management page you need.
* Use the `Campaigns`, `Analytics`, `Donations`, and `Donor Management` sections to move between workflows.
* Before sharing a public campaign, make sure the campaign is active and ready for donors to see.
## Outreach Campaigns
Outreach Campaigns also coordinate donation-drive posts from **Members → Needs
& Offers**. A moderator with Outreach Campaign access can link an active
campaign before publishing the post. Members then open this same campaign for
requested items, contributions, delivery details, and progress rather than
using a separate donation workflow.
Use the campaigns page to create, review, and organize all outreach campaigns in one place.
![Outreach campaigns screen]()
### What You Can Do
* Create a campaign
* Search campaigns
* Filter campaigns by status
* Open a campaign for more detail
* Generate a public link
* Edit or delete a campaign
### Steps
1. Open `Outreach Campaigns`.
2. Stay on `Campaigns`.
3. Use search or the status filter to find the campaign you want.
4. Click `Create Campaign` to add a new campaign, or open an existing one to manage it.
5. Use the page actions when you need to update or share the campaign.
### Notes
* Campaign cards help your team compare progress quickly.
* Active campaigns are the best choice for public sharing.
## Public Campaign Links
Use the public link tool when you want to share a church-wide outreach page outside the admin dashboard.
![Public campaigns link modal]()
### What You Can Do
* Copy the public campaigns link
* Copy embed code for a website or landing page
* Share one outreach destination with supporters
### Steps
1. Open `Outreach Campaigns`.
2. On the `Campaigns` page, click `Generate Public Link`.
3. Copy the direct link or the embed code.
4. Share it with your website manager, church team, or donors.
### Notes
* The public link opens the church's campaign page outside the admin dashboard.
* Use embed code when you want campaigns displayed inside another website.
## Campaign Items and Setup
Use the campaign details page to review the setup of an individual campaign and monitor what supporters still need to give.
![Campaign items and setup]()
### What You Can Do
* Review the campaign description
* Confirm whether the campaign accepts cash, items, or both
* Track item goals and current progress
* Review donor and donation totals
* Check delivery instructions
* Open editing when updates are needed
### Steps
1. Open `Outreach Campaigns`.
2. Select the campaign you want to review.
3. Check the description, dates, and donation types.
4. Review the campaign items and progress bar.
5. Review the statistics and delivery information.
6. Click `Edit` when the campaign needs changes.
### Notes
* Item progress helps your team see what is still needed.
* Delivery information is useful when supporters are bringing physical items in person.
## Campaign Donations
Use the donations page to review pledged and received support across all outreach campaigns.
![Campaign donations screen]()
### What You Can Do
* Review giving totals across campaigns
* Search donations
* Filter by status
* Filter by type
* Review campaign, amount, and date details
* Remove a donation record when needed
### Steps
1. Open `Outreach Campaigns`.
2. Click `Donations`.
3. Review the summary cards and currency totals.
4. Use search or filters to narrow the donation list.
5. Review whether each record is `Received` or `Pledged`.
### Notes
* Donation records can include both cash and item-related activity.
* Status helps your team separate promised support from what has already arrived.
## Donor Directory
Use the donor directory to review everyone who registered or gave through outreach campaign pages.
![Donor directory screen]()
### What You Can Do
* Search donors
* Filter donors by form
* Choose which columns to display
* Open donor details
### Steps
1. Open `Outreach Campaigns`.
2. Expand `Donor Management`.
3. Click `Donors`.
4. Use the search box or form filter to narrow the list.
5. Use `Columns` if you want to change what the table shows.
6. Click a donor name or the view icon to open donor details.
### Notes
* Donors appear here after they register through campaign donation pages.
* Column selection helps your team focus on only the details needed for follow-up.
## Donor Details
Use the donor details drawer to review supporter information without leaving the donor list.
![Donor details drawer]()
### What You Can Do
* Review contact information
* See additional form responses
* Review donation statistics
* Open donation history
### Steps
1. Open `Outreach Campaigns`.
2. Click `Donor Management`, then `Donors`.
3. Click a donor name or the view icon.
4. Review the `Information` tab.
5. Switch to `Donation History` when you need the full giving record.
### Notes
* The donor details view opens in a side drawer for quick review.
* The information shown can vary depending on the donor form used during registration.
## Donor Forms
Use donor forms to decide what extra information supporters should provide when they engage with a campaign.
![Donor forms screen]()
### What You Can Do
* Create a donor form
* Search forms
* Filter forms by status
* Review how many fields a form contains
* See whether a form is already attached to a campaign
### Steps
1. Open `Outreach Campaigns`.
2. Expand `Donor Management`.
3. Click `Donor Forms`.
4. Use search or the status filter to find the form you want.
5. Click `Create Form` when you need a new donor form.
6. Review whether a form is already attached before making changes.
### Notes
* Attached forms stay linked to the campaign that uses them.
* Donor forms are useful when you need more than basic name and email details.
* Donor Forms is separate from the top-level [Forms product](/product/forms).
Use Donor Forms for campaign-specific supporter information and Forms for
broader church intake and follow-up.
* A reviewed Forms response can create an Outreach review reference, but it
does not copy the response into donor records.
## Campaign Analytics
Use analytics to monitor campaign performance and share progress with leadership or your fundraising team.
![Campaign analytics screen]()
### What You Can Do
* View total campaigns and active campaigns
* Review total cash pledged and total donors
* Filter by time period
* Filter by campaign status
* Switch between `Overview`, `Campaigns`, `Donations`, and `Trends`
* Review status distribution and monthly trends
### Steps
1. Open `Outreach Campaigns`.
2. Click `Analytics`.
3. Choose the time period you want to review.
4. Apply a campaign status filter if needed.
5. Switch between the analytics tabs to review the metrics you need.
### Notes
* Analytics is especially useful for reporting and campaign follow-up meetings.
* Filters help teams review the same time window before making decisions.
## Public Campaign Pages
Use the public campaigns page to show all active outreach opportunities in one supporter-friendly experience.
![Public campaigns page]()
### What You Can Do
* Browse all active campaigns
* Search public campaigns
* Open an individual campaign page
* Share a clean public giving experience with supporters
### Steps
1. Open the public campaigns link.
2. Review the campaign cards on the page.
3. Use search if you need to narrow the list.
4. Click `Donate Now` on the campaign you want to open.
### Notes
* The public campaigns page is designed for supporters outside the admin dashboard.
* This page can display multiple active campaigns at the same time.
## Public Donation Flow
Use the campaign detail page to review the full campaign story and start the donation process.
![Public campaign detail page]()
### What You Can Do
* Review the campaign description
* See whether the campaign accepts items, cash, or both
* Review timeline and delivery information
* Review campaign progress
* Start the donation process
### Steps
1. Open a public campaign page.
2. Review the campaign details and item needs.
3. Click `Make a Donation`.
4. Sign in if prompted.
5. Continue with the donation steps shown on screen.
### Notes
* The current public experience asks supporters to sign in before completing a donation.
* Campaign detail pages help donors understand what is still needed before they give.
## Public Campaign Payment Page
Use the public payment page to review a donation summary before the supporter completes payment.
![Public campaign payment page]()
### What Supporters Can Do
* Review the campaign name and donation amount
* Confirm donor name, email, and notes
* Continue to payment after signing in
### Steps
1. Open a public campaign page.
2. Start the donation flow.
3. Review the donation summary on the payment page.
4. Confirm the donor details are correct.
5. Sign in and continue with the payment options shown for that church.
### Notes
* The page shows the donation summary before the payment is completed.
* Payment options appear after the supporter signs in.
## Public Donor Profile Page
Use the public donor profile page to give returning supporters one place to review their donor account after sign-in.
![Public donor profile sign-in page]()
### What Supporters Can Do
* Open a public donor profile page
* Sign in before viewing donor details and giving history
* Return to the profile page to review their account
### Steps
1. Open the public donor profile page.
2. Use the profile sign-in option.
3. Return to the donor profile page after sign-in.
4. Review the donor details and giving history shown on the page.
### Notes
* Before sign-in, the page shows a `Sign In Required` message instead of donor history.
* After sign-in, supporters can review their donor profile and past donations in the same public experience.
# Pastoral Care
Source: https://docs.thefaithapp.com/product/pastoral-care
Receive confidential member care requests and coordinate safe, accountable follow-up.
Pastoral Care gives members a private place to ask their church for help and
gives authorized staff one organized workspace for follow-up.
Members can request general care, hospital or home visits, new-baby support,
counseling, benevolence, grief, illness, crisis support, pastoral follow-up,
wedding preparation, baby dedication, funeral support, relocation support, or
a pastoral recommendation. Requests do not appear in community feeds or public
member directories.
Pastoral Care is not an emergency service. If someone may be in immediate
danger, use the emergency and safeguarding process appropriate to your
location and church. Do not wait for a dashboard response.
Ask for care, choose who may see it, follow progress, and control private
follow-up preferences.
Own permitted cases, plan the next step, coordinate visits, and keep a
minimal accountable record.
Set permissions, response coverage, consent boundaries, retention, and
review practices before rollout.
Offer the same member-owned experience in a church app through the public
Pastoral Care API.
## Start With the Right Workspace
| Need | Open |
| ---------------------------------------------------- | ---------------------------------------------------- |
| Review and own confidential member requests | `Church Management > Pastoral Care > Care Requests` |
| Schedule visits, availability, and response coverage | `Church Management > Pastoral Care > Coordination` |
| Review member-approved dates and due follow-up | `Church Management > Pastoral Care > Life Moments` |
| Review consent-backed signals | `Church Management > Pastoral Care > Care Radar` |
| Coordinate a funeral or wedding | `Church Management > Pastoral Care > Rite Runsheets` |
| Cover a caregiver's planned absence | `Church Management > Pastoral Care > Coverage Mode` |
| Plan upcoming preaching and review Scripture history | `Church Management > Pastoral Care > Preaching Plan` |
## Before You Start
Before inviting members to use Pastoral Care:
1. Name the leader accountable for safeguarding and response quality.
2. Give `Pastoral Care` only to staff who should see ordinary cases.
3. Give `Sensitive Pastoral Care` only to the smaller group permitted to see
pastoral-only, counseling, benevolence, crisis, and restricted life-moment
information.
4. Confirm who owns new requests during weekdays, weekends, and staff absence.
5. Agree on your urgent-care and emergency handoff process.
6. Review the configured closed-case retention period.
7. Submit a test request and practice assignment, follow-up, resolution,
withdrawal, and content removal before announcing the feature.
## Where Members Find It
Members open `Connect` in the mobile app and tap `Pastoral Care`.
From there, a member can:
* Share a new confidential care request.
* Choose how soon they need follow-up.
* Choose in-app, phone, text, or email contact.
* Review active and past requests.
* See whether a caregiver has been assigned.
* See the next scheduled follow-up when one is available.
* Review scheduled care visits, the assigned caregiver, and the information
needed for the visit.
* Review a new-baby support plan and the kinds of support being coordinated.
* Choose which private life-moment dates the care team may remember.
* Pause automated celebration messages during a sensitive season.
* Edit or withdraw an open request.
## Sharing a Care Request
To share a request:
1. Open `Connect`.
2. Tap `Pastoral Care`.
3. Tap `Request care`.
4. Choose the type of care.
5. Describe what the care team needs to know.
6. Choose the privacy boundary and urgency.
7. Choose a preferred contact method.
8. Confirm that the church care team may contact you.
9. Tap `Share confidentially`.
Counseling, benevolence, and crisis requests are automatically restricted to
pastoral staff. Other requests can be shared with the wider authorized care
team or restricted to pastoral staff.
Urgent and crisis requests show an additional safety notice. Pastoral Care is a
church ministry workflow, not an emergency service.
### Choosing a Privacy Boundary
`Care team` means authorized caregivers may see the request on a
need-to-know basis. `Pastoral staff only` restricts it to staff who also have
Sensitive Pastoral Care access.
Counseling, benevolence, and crisis requests always use the pastoral-only
boundary. This safeguard applies even if a member-facing app submits a wider
choice.
## The Staff Care Workspace
Authorized staff expand `Pastoral Care` under `Church Management` and open
`Care Requests`.
The workspace shows active, new, urgent, unassigned, and overdue totals. Staff
can search for a member and filter the queue by status, type, urgency, or
owner.
Opening a request lets an authorized caregiver:
* Assign an eligible same-church owner.
* Move the request from assigned to in progress and resolved.
* Schedule the next follow-up.
* Add confidential notes.
* Create and complete follow-up tasks.
* Record a private resolution summary.
* Review the safe activity history.
* Schedule and complete hospital or home visits.
* Create a new-baby support plan with dates, a coordinator, and requested
support.
A caregiver must be assigned before care can move into active follow-up. Closed
requests cannot be reopened.
## A Reliable Daily Care Rhythm
A simple operating rhythm keeps urgent work visible without turning the
workspace into a surveillance system:
1. Review new, urgent, unassigned, and overdue totals at the beginning of the
care team's working day.
2. Assign one eligible owner to each request that is ready for follow-up.
3. Agree on the next action and record the next follow-up date.
4. Use visits and tasks for concrete commitments rather than placing long
narratives in notes.
5. Resolve a request only after the agreed care step is complete, then record
the minimum useful resolution summary.
6. Review upcoming visits and response coverage before weekends, holidays, and
planned caregiver absences.
When more detail is not needed for continuity or accountability, do not record
it.
## Coordinating the Care Team
Expand `Pastoral Care` under `Church Management` and open `Coordination` to see
the shared care schedule.
The coordination view shows:
* Upcoming visits for cases the current staff member is permitted to see.
* Primary and backup response coverage.
* Recurring weekly availability for each caregiver.
* Simple counts for active cases, open tasks, and scheduled visits.
Use `Schedule coverage` to assign a primary caregiver, an optional backup, and
the response window. Use `Edit availability` beside a caregiver to add or
remove their recurring weekly windows.
These counts help the team distribute ordinary work. They are not a workload
score, wellbeing assessment, or automatic overload warning. Coverage notes are
for operational rotation information only and should never contain member or
case details.
## Member-Approved Life Moments
Members open `Pastoral Care` and tap `Manage care preferences`.
Reminders are off by default. A member can:
* Allow birthday, grief, illness, crisis, or hard-anniversary follow-up
separately.
* Choose in-app, phone, text, or email as the preferred contact method.
* Say whether a gentle message is welcome, the care team should ask first, or
the date should be remembered without contact.
* Add a one-time or yearly private date and choose how many days ahead the
assigned caregiver should be reminded.
* Pause, edit, or permanently remove a private date.
These dates are not community recognition posts. They create a confidential
staff follow-up only after the member opts in.
Authorized staff open `Life Moments` from the `Pastoral Care` submenu to review
due follow-ups, assign an eligible caregiver, and record the minimum encrypted
outcome needed for continuity. Restricted grief, crisis, and hard-anniversary
moments remain visible only to staff with Sensitive Pastoral Care access.
## Consent-First Care Radar
Authorized staff open `Care Radar` from the `Pastoral Care` submenu to review
supported signals that may need human attention.
Care Radar is disabled by default. An eligible administrator can enable it and
choose thresholds for:
* Confidential care cases that remain unowned.
* Confidential follow-ups that become overdue.
* A caregiver's active-case count reaching a simple review point.
* Consecutive recorded Community Group absences.
Community Group participation review also stays off for each member until that
member separately enables both Care Radar and group participation follow-up in
their Pastoral Care preferences.
Every signal remains a review prompt. It does not diagnose a member, assign a
wellbeing label, send a message, or open a care case. Authorized staff can
acknowledge or dismiss a visible signal and may add a minimum encrypted review
note.
The source-readiness list in the Care Radar view identifies sources that are
not yet available. General service attendance, guest continuity, household
attendance drift, serving decline, and stopped-serving review remain deferred
until their histories and consent boundaries are reliable.
## Rites, Coverage Mode, and Preaching Planning
Authorized staff expand `Pastoral Care` under `Church Management` and open the
specific workspace they need.
### Funeral and Wedding Runsheets
Open `Rite Runsheets` to create a funeral or wedding planner from an existing
confidential care case. The workspace adds a ten-item starting checklist for
family communication, people, service details, venue, documents, music, and
practical logistics.
Staff can assign a coordinator, record the event date and venue, add only the
family preferences and private details needed for coordination, and add custom
checklist items. Checklist items and the runsheet move forward and cannot be
reopened after completion or cancellation.
### Caregiver Coverage Mode
Open `Coverage Mode` when a caregiver will be away. Select the caregiver,
the person covering, the date window, and a minimum encrypted handoff summary.
The workspace snapshots the caregiver's active assigned cases at that point.
The covering caregiver can record a per-case next action and see how many
tasks and activities were recorded during the coverage period. Ending coverage
hands open items back for re-entry review. This is a bounded absence workflow,
not a permanent transfer of care.
### Preaching Calendar and Scripture Ledger
Open `Preaching Plan` to record the scheduled date, audience, service,
speaker, title, series, Scripture references, and relevant liturgical or civil
moments. Preparation notes remain encrypted.
When a reviewed plan is marked delivered, its Scripture references contribute
to the Scripture ledger. The ledger starts with manual plans recorded in this
workspace. Older sermon upload dates are not treated as preached dates.
These three areas are staff-only. Members continue to see safe status,
follow-up, and visit information through their linked Pastoral Care case.
## Quiet Days and Milestone Messages
Members can add a quiet-day window for birthday, wedding-anniversary,
baby/family, or all celebration messages. The existing automated directory
birthday and anniversary reminder excludes the member while that suppression
is active.
A member can optionally allow a private pastoral acknowledgment and add
restricted guidance. The reason and guidance are not shown to the wider care
team.
## Scheduling a Visit
Open a care request and select `Schedule visit`. Choose a hospital, home, or
other visit, then set the caregiver, date and time, location, and only the
private instructions needed for the visit.
After the visit, select `Complete` and record the minimum outcome needed for
continuity. A scheduled visit can also be cancelled. Completed and cancelled
visits cannot be reopened.
Members can review their own visit schedule and safe visit details in the
mobile app. Staff coordination controls and support-plan notes are never shown
there.
## New-Baby Support Plans
When a member chooses `New-baby support`, authorized staff can create a support
plan in the same care case. Choose a coordinator, plan dates, and the requested
support, such as meals, visits, transport, supplies, or prayer.
Members can see the coordinator, dates, and selected support. Private
coordination notes remain staff-only.
## Rollout and Review
Start with a small care team and a test member account. During the first weeks,
review:
* How long new and urgent requests wait for an owner.
* Whether next follow-up dates are being kept current.
* Whether members receive the contact method they chose.
* Whether caregivers are recording only the minimum necessary information.
* Whether sensitive access is limited to the intended people.
* Whether weekend and absence coverage is clear.
* Whether withdrawn and resolved requests move through retention as expected.
Do not use active-case counts as a performance score. The number of cases does
not describe complexity, emotional weight, caregiver wellbeing, or quality of
care.
## Permissions
Pastoral Care uses two staff permissions:
* `Pastoral Care` allows access to ordinary care-team cases.
* `Sensitive Pastoral Care` allows access to pastoral-only, counseling,
benevolence, and crisis cases, restricted life moments, and Community Group
absence signals. It is also required for rite runsheets and caregiver
absence coverage.
Preaching planning is available to staff who already manage audio or video
sermons and have access to the Pastoral Care workspace.
Changing the church's Care Radar policy requires both administrator access and
`Sensitive Pastoral Care`.
Hiding the dashboard link is not the security boundary. Requests are also
filtered by church and permission when they are loaded or changed.
## Privacy and Retention
Request details, contact details, notes, task content, visit location and
instructions, visit outcomes, support preferences, support-plan notes,
coverage notes, private life-moment titles and guidance, quiet-day reasons,
follow-up outcomes, Care Radar review notes, rite family and logistics
details, runsheet checklist content, caregiver absence handoffs, per-case next
actions, preaching preparation notes, and resolution summaries are encrypted.
Staff access and important workflow actions are recorded.
Notifications use general language. They do not place a member's identity,
contact details, request content, notes, task content, or resolution content in
the alert.
After a request is resolved or withdrawn, private content is kept for the
configured retention period and then removed. The minimum status and activity
history remains for accountability.
## Prayer Follow-Up
When authorized staff create a Pastoral Care handoff from an urgent prayer
request, the handoff opens a linked care case. The original prayer title and
description are not copied into the care case. Only the minimum coordination
note and source reference move across the boundary.
## Pastoral Care in a Church App
Third-party church apps can offer the same member-owned care-request,
life-moment, and quiet-day workflows through the supported `v1` partner API.
Only the member-facing mobile operations are public. Staff notes, tasks,
coordination, Care Radar review, rites, coverage, and preaching tools remain
inside the protected staff product.
Developers should follow the
[Pastoral Care integration guide](/api-reference/pastoral-care) and generated
endpoint reference.
## Troubleshooting
### A staff member cannot see a request
Confirm that the staff member belongs to the same church and has `Pastoral
Care`. If the request is pastoral-only or uses a sensitive care type, they also
need `Sensitive Pastoral Care`.
### A request cannot move to in progress
Assign an eligible caregiver first. The care workflow does not allow active
follow-up without a clear owner.
### A request cannot be edited or reopened
Resolved and withdrawn requests are closed. They cannot be reopened. After
retention removal, confidential request content also cannot be restored.
### A private date does not create follow-up
Confirm that the member enabled the master reminder setting and the matching
follow-up type, the private date is active, and an eligible caregiver is
assigned. A quiet day may also intentionally suppress celebration messaging.
### Care Radar does not show Community Group absence signals
The church policy, member Care Radar consent, and member Community Group
participation consent must all be enabled. The member must also have qualifying
recorded group attendance history.
### The wrong caregiver appears unavailable
Review the recurring availability record and the coverage date range. Coverage
Mode is a bounded absence handoff; it does not permanently reassign the
caregiver's cases.
## Not Included Yet
This release does not yet include:
* General service-attendance, household-drift, guest-continuity, or
serving-disengagement signals.
* Automated meal trains or geographic visit routing.
* Baptism testimony or class/readiness destinations.
* Automatic month-three, first-holiday, or long-illness pacing templates.
* Weighted caregiver overload scoring, wellbeing labels, keyword urgency
inference, or automatic member-facing action from a Care Radar signal.
* Sealed successor handoff dossiers or a personal-story illustration vault.
* Automatic historical sermon-ledger import.
* Specialized recovery, confession, reconciliation, immigration, prison
correspondence, or anonymous care workflows.
These areas will be added in later dependency-aware phases after their source
data, consent, communication, and safeguarding rules are available.
# Personalized Home
Source: https://docs.thefaithapp.com/product/personalized-home
See the parts of church life that matter to you today, without searching through the app.
Personalized Home turns the first screen of the mobile app into a simple view
of your church week. It combines your own commitments and connections with the
church's sermons, devotionals, events, and bulletin.
## Start with your week
Open **Home** in the mobile app to see:
* A personal greeting and an ordered list of useful next steps.
* Your next registered event, Community Group meeting, or serving commitment.
* Announcements from Community Groups you have joined.
* Sermons and saved moments you want to revisit.
* A listening card when you leave an audio sermon unfinished.
The app only shows sections that have something useful to say. If you have no
upcoming commitment or saved sermon, the normal church content remains easy to
reach without empty cards taking up space. When none of your personal sections
has an update, Home shows a quiet all-caught-up message so the screen still
feels intentional and welcoming.
If your church publishes a custom Home design, these personal sections appear
above that church-authored content. You keep the same commitments, suggestions,
saved media, and sermon resume experience without losing the layout your church
created.
Home headings, actions, dates, participation labels, commitment context, and
recommendations follow the language selected in the app.
## Use quick actions
The Home screen keeps five common actions together:
* **Give** opens in-app giving.
* **Prayer** opens the church prayer community.
* **Check in** opens upcoming events and registrations.
* **Chat** opens member conversations.
* **Sermons** opens the sermon library.
## Follow your suggested next steps
The **For you** section orders practical actions using the connections and
participation already recorded in your profile. It may help you choose a
campus, find a Community Group, explore an upcoming event, discover an active
place to serve, request prayer, or continue a pastor conversation you already
requested.
The app only shows a recommendation when its destination is available for your
church. Membership classes, baptism, and Bible-plan steps stay hidden until
those experiences are ready and configured. Recommendations do not guess at
private spiritual, pastoral, or personal circumstances.
## Continue a sermon
When you stop an audio sermon after the opening moments, the app remembers the
sermon and your position on that device. Select **Resume** on Home to continue
where you left off. Finished sermons and items stopped near the end are removed
from the resume card automatically.
## Privacy
* Home only uses information attached to your signed-in church membership.
* Group announcements only appear for Community Groups you have joined.
* Saved sermon notes are only returned to the member who created them.
* Personalized Home data is cached for offline use and cleared when the local
member session is cleared.
# Prayer Community
Source: https://docs.thefaithapp.com/product/prayer-community
Help members share approved prayer requests, pray for one another, and follow up when prayers are answered.
# Prayer Community
Prayer Community gives members a shared church prayer feed inside the mobile app. It turns prayer requests into a simple community rhythm: someone submits a need, the church reviews and approves it, members pray, and the requester can later mark the request answered with a testimony.
This feature is church-scoped in the current release. Members see approved
church requests and eligible Community Group requests, not a public global
prayer wall. Leaders-only and pastoral-only requests stay out of member feeds.
## Where Members Find It
Members open Prayer Community from the `Connect` page by tapping `Prayer community`.
From there, they can browse approved requests, submit a new request, mark that
they prayed, return to their own requests for follow-up, or use a private
prayer journal.
## What Members Can Do
* Submit a new prayer request from the mobile app.
* Choose the Church Prayer Wall, one of their active Community Groups, church
leaders, or the authorized pastoral team as the request audience.
* Choose whether the request should appear anonymously.
* View approved requests shared by their church.
* Tap `I prayed` to show support for a request.
* See how many members have prayed for a request.
* Review their own submitted requests.
* Mark their own request as answered.
* Add optional testimony text when a prayer has been answered.
* Edit an active request and return it for review.
* Withdraw a request from member Prayer Walls.
* Filter the Prayer Wall between active and answered requests.
* Keep member-only journal prayers and private answered reflections.
* Copy a journal prayer into a moderated request when they want others to
pray with them.
* Set daily, weekly, journal-specific, and prayed-request follow-up reminders.
* Open a verified prayer-team daily list and mark assignments praying or
completed.
* Privately ask church leaders for urgent follow-up on an active request.
* Open a locked Prayer Room when staff arrange immediate live prayer with a
verified prayer-team leader.
## Submitting a Prayer Request
Members use the Prayer Community submit flow when they want the church to pray with them.
Typical steps:
1. Open `Connect`.
2. Tap `Prayer community`.
3. Open the submit request action.
4. Enter the request title and description.
5. Choose who can see the request.
6. Choose whether to submit anonymously.
7. Submit the request.
After submission, the request follows the church approval process before it
appears in an eligible member feed. Editing an approved request also returns it
for review.
When a situation needs timely attention, the member can also ask leaders for
urgent follow-up and include a short private reason. This signal and reason
stay out of the Prayer Wall.
### Audience Choices
* **Church Prayer Wall:** approved requests can be seen by members of the
church.
* **Community Group:** approved requests can be seen only by active members of
the selected group.
* **Church leaders only:** the request stays out of member Prayer Walls.
* **Pastoral team only:** the request is encrypted and restricted to staff
who have private pastoral prayer access.
Audience and anonymity are separate. For example, a member can share an
anonymous request with their Community Group or a named request with leaders
only.
### Private Pastoral Requests
Choose `Pastoral team only` when the prayer itself and the follow-up need a
smaller confidentiality boundary than the general church-leader workflow.
The member app explains this boundary before submission:
* The member's identity is shared only with authorized pastoral caregivers so
they can follow up safely.
* The private content is encrypted and access is recorded.
* The request does not appear on a Prayer Wall, in a prayer-team list or
digest, in a Prayer Room, or in a general export.
* Staff exports contain workflow metadata only, not the prayer, identity, or
contact details.
* After the request is answered, withdrawn, or rejected, the church keeps the
encrypted content for its configured retention period and then removes it.
A request cannot be changed into or out of the pastoral audience after it is
submitted. Create a new request when a different audience is needed.
## Approval and Moderation
Prayer Community uses the existing prayer request approval flow as the moderation gate.
Approved requests appear in the church feed. Pending, rejected, or unreviewed requests stay out of the feed. This helps churches keep sensitive requests, duplicate submissions, or inappropriate content from becoming visible to the wider community.
For admins and prayer teams, the practical workflow is:
1. Review incoming prayer requests.
2. Approve requests that are appropriate for the church feed.
3. Confirm that the selected audience is appropriate before approval.
4. Keep request status up to date so members see the right requests.
## Anonymous Requests
Prayer requests can be anonymous.
When a request is anonymous, the feed hides the requester identity. This lets members ask for prayer without exposing personal details publicly. Non-anonymous requests can show the member or display name so the church can recognize who is asking.
Use anonymous requests for sensitive needs, family situations, personal struggles, or any request where privacy matters.
## Praying for Requests
Members can tap `I prayed` on a request to show they prayed for it.
Each member can mark `I prayed` once per request. The count helps the requester know that the church is standing with them, without requiring every person to leave a comment or message.
## My Requests
The member's own requests are available for follow-up.
This area helps request owners see what they submitted, track whether the request is still active, and mark it answered when the situation changes.
Owners can also edit an active request or withdraw it. An edit returns an
approved request to the review queue. Withdrawal removes it from member feeds
without deleting the church's follow-up record.
### Urgent Follow-Up
Members can ask for urgent follow-up while submitting a request or from `My
Requests`. The member sees whether the request is awaiting review, approved,
declined, being handled, or resolved. A pending urgency request can be
cancelled.
Urgent follow-up is a private request for the church's ministry team; it is not
an emergency service. Members facing immediate danger should contact the
appropriate local emergency service.
After a leader approves the request, staff can assign an owner, acknowledge
the need, begin follow-up, and record resolution. If live prayer is
appropriate, staff can create a locked Prayer Room for the member and a
verified prayer-team leader. The member can open that room from their request.
### Prayer Room Connection Recovery
If a Prayer Room connection becomes unstable, the room displays
`Reconnecting...` and temporarily pauses microphone, camera, and speaker
controls. The member stays on the room screen while the app tries to restore
the connection.
If the connection cannot recover, the member sees `Try connection again`.
This requests a fresh room session without making them leave and find the room
again. If microphone access has been permanently denied, the app also offers a
shortcut to the device settings where access can be restored.
The room also shows the member's own connection quality. Opening `Connection
help` gives practical suggestions, including changing networks or reducing
video data when bandwidth is limited.
In a video room, choose `Use audio only` from Connection help to pause incoming
video and turn off your camera while keeping prayer audio, chat, and room
controls available. The app does not switch modes automatically. Choose `Show
video again` when the connection improves. Incoming video can return, but your
camera stays off until you deliberately turn it on.
If you switch apps or the room moves into the background, TheFaithApp stops
your microphone and camera from publishing. You remain in the room, and the
app does not silently turn either control back on when you return. A clear
message shows which controls stayed off so you can restore them when ready.
If audio-only mode was active, incoming video remains paused after returning.
Members can review and copy a support diagnostic when they need help. It
contains only the room reference, audio or video mode, connection state and
quality, participant count, retry count, whether audio-only mode is active,
whether microphone or camera publishing was paused after leaving the app, and
capture time. It does not contain the room title, prayer text, names, contact
details, chat, recordings, device identifiers, or an access token, and the app
does not upload it automatically.
## Answered Requests and Testimonies
Request owners can mark their own requests as answered.
When they mark a request answered, they can add optional testimony text. This gives the church a simple way to celebrate answered prayer without creating a separate testimony workflow.
Good testimony text is usually short, specific, and safe to share. Members should avoid including private details about other people unless they have permission.
## Private Prayer Journal
The `Journal` area is for prayers a member wants to keep completely private.
Journal entries do not appear in the Prayer Wall, the staff prayer inbox,
exports, prayer-team lists, or church analytics.
Members can:
1. Add a title and private prayer or reflection.
2. Edit the entry as the situation changes.
3. Mark it answered and add an optional private reflection.
4. Return an answered entry to active when they want to keep praying.
5. Delete the entry and its reminder permanently.
When a member chooses `Share request`, Prayer Community copies the journal
entry into a new request. The member still chooses an audience and whether to
appear anonymously, and the copied request follows church review. The journal
entry itself stays private and can be shared only once.
## Prayer Reminders
The reminder card at the top of `Journal` supports:
* A daily prayer time.
* A weekly prayer time on the member's chosen day.
* A one-time reminder for a private journal entry.
* A one-time follow-up for a request the member owns or has marked
`I prayed`.
Reminder delivery uses the time zone in the member's communication
preferences. One-time reminders turn off after delivery; daily and weekly
rhythms continue until the member removes them.
For privacy, push notifications use a general journal message instead of
placing the private prayer description on the device lock screen. Tapping the
notification opens Prayer Community.
## Prayer Teams
Church staff can open `Prayer Teams` in the dashboard to create teams from the
church's already verified prayer volunteers. Each roster member has a leader,
coordinator, or intercessor role, an active or paused status, optional weekly
availability, and an explicit weekly-email preference.
The member app shows a prayer-team card only to active roster members whose
prayer-volunteer profile remains verified. Opening it creates a stable daily
list and lets the member mark each assignment as praying or completed.
Daily lists use these privacy rules:
* Approved church requests can be added automatically.
* Leaders-only requests require a deliberate staff assignment.
* Community Group requests never enter a prayer-team list.
* Pastoral-only requests never enter a prayer-team list or digest.
* Anonymous requests stay anonymous.
* Team screens and emails do not include requester phone or email details.
The weekly digest is sent on the team's configured local schedule to active,
opted-in, still-verified roster members. Each recipient gets at most one
delivery per team and week.
## Current Scope
Prayer Community currently focuses on the core church prayer loop:
* Member submission
* Church approval
* Approved church feed
* `I prayed` support
* Owner follow-up
* Answered requests
* Optional testimony text
* Anonymous display rules
* Church, Community Group, leaders-only, and pastoral-only audiences
* Owner editing with moderation review
* Owner withdrawal
* Active and answered Prayer Wall filters
* Member-private prayer journal with answered reflections
* One-time journal-to-request sharing through normal moderation
* Daily and weekly prayer rhythms
* Journal and prayed-request follow-up reminders
* Verified prayer-team rosters, roles, availability, and assignments
* Permission-safe daily prayer lists
* Weekly prayer-team email digests
* Private member-requested urgency with staff review
* Safe alerts to authorized church leaders
* Assigned urgent follow-up through acknowledgement, work, and resolution
* Bounded Pastoral Care handoffs that do not copy the prayer text
* Locked urgent Prayer Rooms with verified prayer-team leaders
* Encrypted pastoral-only requests with restricted access, access history,
metadata-only export, and timed content removal
The following community expansion ideas are intentionally left for later phases:
* Public or global prayer walls
# Prayer Rooms
Source: https://docs.thefaithapp.com/product/prayer-rooms
Host beta audio and video prayer rooms with speaker controls, recording options, and room-specific giving.
# Prayer Rooms
Prayer Rooms let members gather live in the mobile app for hosted prayer, support, and ministry moments. A room can be audio-first, like a stage or group prayer call, or video-based for smaller face-to-face gatherings.
This release is marked as beta because live audio, video, recording, and giving all need real-device QA across different phones, browsers, networks, and church payment setups.
## Where Members Find It
Members open Prayer Rooms from the `Connect` page by tapping `Prayer Rooms`.
The button includes a `Beta` label so churches know the feature is available for testing and early use while final QA continues.
## What Members Can Do
* View live prayer rooms.
* View upcoming scheduled rooms.
* Create a room when their role allows it.
* Join a live room quickly.
* Speak when they are the host, moderator, speaker, or approved participant.
* Listen when they join as a listener.
* Mute and unmute their microphone.
* Turn camera on or off in video rooms.
* View who is in the room.
* Report a room when something needs review.
* Give toward a room goal when room giving is enabled.
## Audio Rooms
Audio rooms are designed for prayer gatherings where a few people speak and others listen.
They work well for:
* Morning prayer
* Intercession
* Pastoral prayer sessions
* Member support gatherings
* Short church-wide prayer moments
Audio rooms show participant count, speaker/listener state, mute state, and speaking indicators so hosts can understand what is happening without needing a large meeting layout.
## Video Rooms
Video rooms are designed for smaller or more interactive gatherings where seeing faces matters.
They work well for:
* Prayer team meetings
* Small group prayer
* Volunteer prayer check-ins
* Ministry support calls
* Scheduled pastoral care sessions
The video layout is intentionally compact. It does not try to show every participant as a large tile when a room grows. The main call stays readable, and participants can be reviewed from the participant list.
## Creating a Room
When creating a room, hosts choose the setup that fits the gathering.
Common options include:
* Room title
* Audio or video room type
* Participant limit
* Church, partner-church, or global discovery
* Room giving
* Prayer clips
* Recording consent
* Locked room
* Recurring room
* Scheduled start time
After a room is created, the host is taken directly into the room. This keeps the flow short: create the room, enter the room, and begin hosting.
During the Prayer Rooms trial, a church can host one live room at a time with up to 10 participants and 500 participant minutes per billing period. Prayer Rooms Plus allows larger rooms, more live room flexibility, and a higher included participant-minute allowance.
## Choosing Who Can Discover a Room
Hosts can keep a room inside their church, share it with selected partner churches, or make it discoverable across the wider network when their church has access to those options.
For a partner-church room, search by church name or location and select one or more churches from the results. The app saves the church details automatically, so hosts do not need to find or enter church IDs.
Partner-church and global rooms are public and unlocked so eligible members can discover and join them. Use a church-only room when the gathering should remain within the host church.
## Joining a Room
Members can join live rooms from the Prayer Rooms screen.
The app keeps the join flow short so members do not have to move through multiple setup pages. Once they join, the meeting controls are shown inside the room.
If a member is a listener, they join in listen-only mode. If they are allowed to speak, they can publish microphone audio.
## Roles and Controls
Prayer Rooms use role-based controls.
Hosts and moderators can manage the room. Speakers can talk when allowed. Listeners can join and listen without publishing audio unless their role changes.
Room controls can include:
* Leave room
* End room
* Mute or unmute
* Camera on or off
* Request to speak
* Start or stop recording when allowed
* View participants
* Report room
When a host ends the room, connected participants are removed from the live session.
## Participants
Rooms show a preview of current participants and a full participant list.
Participant state helps hosts and members understand who is active:
* Muted
* Speaking
* Listening
* Speaker or host role
This is especially useful in larger audio rooms where not everyone can be shown prominently on the main screen.
## Recording and Prayer Clips
Rooms can require recording consent before recording or prayer clips are used.
Recording controls are shown only to users who can manage the room. Prayer clips and transcripts are part of the recorded-room workflow and should be used only when the church has set the right consent expectations.
Good practice is to tell members when a room may be recorded and why clips may be used.
## Room Giving
Room giving lets a room include a giving action and optional goal amount.
When the church has a connected payment provider, members can give in the app. Native in-app gifts can be counted toward the room goal, so the room can show progress such as `USD 500 of USD 2,000`.
Supported native payment setup depends on the church account having at least one provider ready:
* Stripe
* PayPal
* Flutterwave
If the church does not have a native payment provider, the room can use an optional external giving link instead. External gifts open outside the app and are not counted in the room progress bar because TheFaithApp cannot track those external transactions automatically.
## Current Beta Notes
* Hosts can choose church-only, selected partner-church, or global discovery when their church has access.
* Partner churches are selected by searching for their church name or location.
* The mobile app labels Prayer Rooms as beta from the Connect page.
* Trial rooms support one live room at a time and up to 10 participants.
* Partner-church and global rooms stay public and unlocked.
* Room giving progress is shown only for native in-app gifts.
* External giving links are available as a fallback when native payment setup is not ready.
* Real-device QA should include audio permissions, camera permissions, WiFi, cellular, recording consent, room ending, and giving behavior.
# Settings, Branding, and App Customization
Source: https://docs.thefaithapp.com/product/settings-branding-and-customization
Manage church profile details, social links, email delivery, developer setup, white-label branding, domains, and mobile app customization in TheFaithApp.
# Settings, Branding, and App Customization
This guide covers the settings and customization areas used to manage church details, public branding, technical app setup, and the mobile app experience in TheFaithApp.
These tools include:
* Church profile
* Social media links
* Email settings
* Developer tools and Firebase setup
* White-label branding
* Custom domains
* Custom branding for public pages
* Brand & theme
* Navigation builder
* Page builder
* Component library
* Customization releases
## Before You Start
* Sign in to your admin account.
* Open `Settings` for church profile, social media, email, developer tools, and branding.
* Open `App Customization` from the six-product sidebar for `Page Builder`, `App Navigation`, `Component Library`, and `Brand & Theme`.
* Some setup steps, especially SMTP and Firebase, may require help from your technical team or provider.
## Church Profile
Use church profile settings to keep your church identity, contact details, and general organization information up to date.
![Church profile settings]()
### What You Can Do
* Update the church name
* Update the main church email address
* Update location and website details
* Choose the correct timezone
* Update the church description
* Upload or replace the church logo
### Steps
1. Open `Settings`.
2. Stay on `Church Profile`.
3. Update the church information you want to change.
4. Upload a new logo if needed.
5. Click `Save Changes`.
### Notes
* Keep this page current because the same church details can appear across other parts of the platform.
## Social Media
Use social media settings to share your public church links with members and visitors.
![Social media settings]()
### What You Can Do
* Add or update Facebook
* Add or update Instagram
* Add or update X
* Add or update YouTube
* Add or update TikTok
### Steps
1. Open `Settings`.
2. Click `Social Media`.
3. Paste the links you want to publish.
4. Click `Save Changes`.
### Notes
* Use full public profile links so members are sent to the right page.
## Email Settings
Use email settings to control the sending address and delivery provider used for church emails.
![Email settings]()
### What You Can Do
* Enter the SMTP host
* Set the port and encryption method
* Add the email username and password
* Set the sending email address
* Set the sender name
* Adjust the timeout when needed
### Steps
1. Open `Settings`.
2. Click `Email Settings`.
3. Enter the SMTP details from your email provider.
4. Set the `From Email Address` and `From Name`.
5. Click `Save Configuration`.
### Notes
* This page is usually completed with details supplied by your email provider or technical team.
## Developer Access
Use Developer Access when connecting an external app to TheFaithApp member sign-in and API access.
![Developer tools settings]()
### What You Can Do
* Copy or rotate the client key
* Register Flutter and React Native apps with guided package-name forms
* Add Redirect URLs for web callbacks and mobile deep links
* Copy a hosted member sign-in link
* Open the hosted sign-in page for testing
### Steps
1. Open `Settings`.
2. Click `Developer Access`.
3. Copy the client key.
4. For a Flutter app, click `Add Flutter app`, enter the package name ending in `.thefaithapp`, and click `Add app`.
5. For a React Native or Expo app, click `Add React Native app` and follow the same package-name pattern.
6. Add any other redirect URL that should receive member sign-in codes.
7. Copy or test the hosted member sign-in link.
8. Rotate the client key only when you are ready to update connected apps.
### Notes
* This area is usually handled together with a technical owner.
* Flutter and React Native apps return directly to the installed app, so a separate callback website is not required.
* Hosted member sign-in runs through TheFaithApp, even when your church uses a custom public domain.
* Client keys can identify your church app, but member access still requires a signed-in member token.
## White-Label Branding and Domains
Use white-label branding to replace default app branding with your church identity and connect a public domain.
![White-label branding settings]()
### What You Can Do
* Turn white-label branding on or off
* Review the branding preview
* Add a custom domain
* Remove a domain when it is no longer needed
### Steps
1. Open `Settings`.
2. Click `Branding`.
3. Stay on `White-Label Branding`.
4. Turn white-label branding on when you are ready to show your own identity.
5. Review the preview area.
6. Click `Add Domain` when you want the app served from your own church URL.
### Notes
* The page currently supports one custom domain per account.
* Domain setup may still require DNS or provider-side work outside TheFaithApp.
## Custom Branding by Page
Use custom branding when you want specific public pages to have their own colors and visual styling.
![Custom branding settings]()
### What You Can Do
* Choose a page type to customize
* Change the page color palette
* Add custom CSS
* Preview the public page look
* Copy branding from another page type
* Turn custom branding on or off
### Available Page Types
* Donations page
* Devotionals
* Outreach campaigns
### Steps
1. Open `Settings`.
2. Click `Branding`.
3. Open the `Custom Branding` tab.
4. Choose the page type you want to style.
5. Update colors or custom CSS.
6. Use `Preview` to review the result.
7. Click `Save Changes`.
### Notes
* This section affects public pages, not the main admin dashboard.
* Each supported page type can have its own visual treatment.
## Brand and Theme
Use Brand & Theme to control the global design language for the app customization workspace.
![Brand and theme editor]()
### What You Can Do
* Set the global color palette
* Choose the main typography style
* Adjust the default corner radius
* Choose the interface theme behavior
* Save a draft
* Restore the default design settings
* Preview the published app structure
### Steps
1. Open `App Customization`.
2. Click `Brand & Theme`.
3. Update the colors, typography, radius, or theme settings.
4. Click `Save Draft`.
5. Use the preview panel to review how the current design feels.
6. Publish when you are ready for the design to become part of the next release.
### Notes
* These settings act as the shared visual base for navigation, custom pages, and reusable components.
## Navigation Builder
Use the navigation builder to control the app tabs members can see and where each tab should go.
![Navigation builder]()
### What You Can Do
* Rename navigation items
* Change navigation icons
* Reorder items
* Point items to system pages or custom pages
* Hide or show individual items
* Save a draft navigation setup
* Publish navigation changes
### Steps
1. Open `App Customization`.
2. Click `Navigation`.
3. Select the item you want to edit.
4. Update its label, icon, target, or visibility.
5. Reorder items when needed.
6. Click `Save Draft`.
7. Click `Publish Navigation` when you are ready to use the updated structure.
### Notes
* Published navigation is used by other app customization previews.
## Page Builder
Use the page builder to create and update custom mobile app pages.
![Page builder]()
### What You Can Do
* Create or select a custom page
* Add text, images, cards, buttons, spacers, dividers, sections, and reusable components
* Edit page details and route information
* Inspect and update individual blocks
* Upload an app bar logo for the page
* Save draft changes
* Publish a page
* Duplicate or delete a page
### Steps
1. Open `App Customization`.
2. Click `Page Builder`.
3. Select the page you want to edit.
4. Add or update blocks in the canvas.
5. Use the right-side inspector to change content and styling.
6. Click `Save Draft`.
7. Click `Publish` when the page is ready.
### Notes
* Published reusable components can be inserted into custom pages from this builder.
* Use the preview mode to check the page before publishing.
## Component Library
Use the component library to create reusable content blocks that can be placed in custom pages later.
![Component library]()
### What You Can Do
* Create reusable carousels
* Use manual content or a data source
* Review published components
* Open and configure existing components
* Publish reusable components for page-builder use
### Steps
1. Open `App Customization`.
2. Click `Component Library`.
3. Review the existing components or click `Add a component`.
4. Choose a template or data source.
5. Configure the component content and behavior.
6. Save and publish the component.
### Notes
* Reusable components help keep shared layouts consistent across custom pages.
## Customization Releases
Use releases to decide when published customization changes should become the live app experience.
![Customization releases dialog]()
### What You Can Do
* Review recent release history
* See which release is live
* Turn `Use custom design` on or off
* Publish a new release
### Steps
1. Open `App Customization`.
2. Click the `Releases` button in the top bar.
3. Review the recent release list.
4. Turn `Use custom design` on when you want the app to use your released customization.
5. Click `Publish a release` when the currently published design, navigation, pages, and components are ready to go live.
### Notes
* A release is a snapshot of the customization that has already been published inside the editor.
* Releases help your team control when customization changes reach the live app.
## Current Product Notes
* `Settings > Branding` controls white-label and public-page branding, while `App Customization` controls the mobile app design workspace.
* Saving or publishing inside `Brand & Theme`, `Navigation`, `Page Builder`, or `Component Library` prepares customization content, but the live mobile app reads the latest release from the `Releases` dialog when `Use custom design` is turned on.