In order to set up the integration with Church Community Builder, you must first create an API User. To create an API User in CCB you must either:

  • Be the Master Admin of your CCB account.

  • Have the Edit System-wide Settings Admin Privilege enabled for your CCB profile.

For a quick demonstration of how to create an API User, just watch the video below. Alternatively, you can follow the written instructions.

Step 1: Log in to CCB

Step 2: Go to System Settings > API

Click the gear icon (⚙️) at the top right corner, and choose "API" from the menu.

Step 3: Copy your API URL

Copy the URL listed next to "Your API URL". You'll need this when setting up the integration in Clearstream.

Step 4: Create a new API User

On the right, click the "Add a new API User" button. You only need to fill out the Name, Username, Password and Re-Type Password fields. You'll need the Username and Password when setting up the integration in Clearstream.

NOTE: Don't save the new user just yet.

Step 5: Add Required Services

The final step is to grant the API User the necessary permissions. Click the "Services" tab at the top.

List of API Services.

Depending on what you'd like Clearstream to do, you'll need to grant the following permissions:

Syncing Groups

group_participants

group_profiles

Creating a New Person

add_individual_to_group

create_individual

individual_groups

individual_profile_from_id

individual_search

Branching Based on Campus

campus_list

Step 6: Save

Finally, click the "Save" button at the bottom of the screen.

Did this answer your question?