All Collections
Integrations
Church Community Builder
CCB Integration Initial Set-Up Guide
CCB Integration Initial Set-Up Guide

How to create an API user and connect Church Community Builder with Text In Church?

Randalin Ward avatar
Written by Randalin Ward
Updated over a week ago

๐Ÿ‘‰ Before we begin, be sure to check out this resource covering the basics of how the integration works and common FAQs about the Integration. ๐Ÿ‘ˆ


In this guide, we'll walk through the initial steps to take so you can start using the CCB Integration with Text In Church.

1. Create an API Username in CCB

  • Log into your CCB account.

  • Click on 'Settings' (Gear Icon). Click on 'API'.

  • You will see the API summary screen. Under 'Actions' click 'Add a new API User.'

  • Create a new API User by filling out the "API User Information Form."

    • Enter your Name

    • Create a username and password

      • This will be a unique username and password that you create. It will only be used for the integration with Text In Church.

      • Do not use your CCB or Text In Church username and password in this form.

  • Add your Primary Organization Contact Information (Organization Name, Contact Name, Phone, and Email)

    • This would only be utilized if there was ever an error with the API that required CCB to contact your organization

  • After completing this form, click on the "Services" tab.

  • Here in the Services tab, you're going to select the following ten checkboxes.

  1. add_individual_to_group

  2. create_individual

  3. group_participants

  4. group_profiles

  5. group_profile_from_id

  6. individual_search

  7. individual_groups

  8. Individual_profiles

  9. individual_profile_from_id

  10. remove_individual_from_group

Be sure not to skip any of these ten, or select any extra as this will cause the integration to not work properly
โ€‹

  • Click 'Save' to complete the process of setting up your API Username and Services (located at the bottom, right-hand corner of the form).

  • Finally, return to the "Summary" tab of the API Settings, and copy the URL within the "Your API URL" box.

2. Enabling the integration in Text In Church

  • Sign in to your Text In Church account

  • Click on Settings (Gear Icon). Click on "Integrations"

  • Click on the "Connect" button by the Church Community Builder integration

  • Paste your API URL into the designated box, then enter the API Username and Password created earlier

  • Click "Save" to continue

3. Selecting Groups to Sync

Within this same page, click the "2. Select Lists" tab

Here you'll be able to search for and select CCB Groups to sync into Text In Church

  • Click the left checkbox by the name to select this Group. These groups will then be created as new, syncing groups within the "Groups" section of your Text In Church account.

  • Optionally, select the "Leader Sync" check box to allow the leader of this CCB Group to sync into this Text In Church

  • Select the frequency you would like this specific group to sync, either nightly, weekly, or monthly.

  • Once you've selected all the needed CCB Groups, click the "Next" button to move to the "3. Sync"

4. Running the First Sync

  • Toggle on the "I have received permission" so that you'll be able to send text/email to your synced people.

  • Toggle on the "Enable automatic sync" so that the integration will sync automatically as determined by each group's set sync frequency.

  • Click "Schedule Sync" to begin your first sync.

  • If you have a large number of people to sync, this first sync could take a few hours to complete. You can close Text In Church or continue using any other part of the application while the sync is running in the background. When completed, the synced groups within the "Groups" section of Text In Church will be populated to match their connected CCB Group.

  • The "Last Synced" section will display the time and date of when the last sync of the integration was completed.

Now that you've completed the Initial Set-Up, check out the following resources๐Ÿ‘‡๐Ÿ‘‡๐Ÿ‘‡

Did this answer your question?