Skip to main content

How do I create an API user in Church Community Builder (CCB)/Pushpay?

Trevor Gehman avatar
Written by Trevor Gehman
Updated yesterday

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

  • Be the Master Admin of your CCB account.

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

Once you have the proper permissions, follow the steps below:

Steps

  1. Log in to CCB.

  2. Go to System Settings (⚙️) > API.

  3. Copy your API URL. You'll need this to set up the CCB integration in Clearstream.

  4. Click the Add a new API User.
    ​
    You only need to fill out the Name, Username, Password, and Re-Type Password fields. Don't save the new user just yet!
    ​
    ​You'll need the Username and Password to set up the integration in Clearstream.

  5. Click the Services tab at the top. Here, you will grant the API User the necessary permissions and required services.

    List of API Services.

    The following services must be checked in order for the Clearstream integration to function properly:

    Syncing Groups & Saved Searches

    execute_advanced_search

    group_participants

    group_profiles

    saved_advanced_search_list

    Using the "Push to CCB" workflow step

    add_individual_to_group

    add_individual_to_queue

    create_individual

    individual_groups

    individual_profile_from_id

    individual_search

    process_list

    Branching Based on Campus

    campus_list

  6. Click Save at the bottom of the screen.

  7. Follow the steps to continue setting up your CCB integration here.

Related Articles
Setting up the Church Community Builder (CCB)/Pushpay Integration
What user permissions do I need to set up the CCB/Pushpay integration?
How often does the CCB integration re-sync?
Automatically retrieve profile data from Church Community Builder (CCB)
How can I sync my CCB Process Queues into Clearstream?
Did this answer your question?