CCB: How to Setup an API User in CCB

You'll want to setup a new, dedicated API user account to only connect with the GroupVitals integration.

Here's how to do that: (see below for a full video tutorial)

1. Login to your CCB as an administrator.

2. Click the cog icon in the top right to access the settings menu.

3. From the settings menu, click API.

4. On the API info page, on the right click "Add a New API User"

5. On the Add a New API User page, fill in all of the fields:

Name: GroupVitals
Username: (e.g, groupvitals)
Password: (give it a strong password)
Organization Name: GroupVitals.com
Contact Name: GroupVitals API Support
Contact Phone: 309-752-8581
Contact Email: [email protected]

At minimum, the API user will need access to these services:

add_individual_to_event
add_individual_to_group
add_individual_to_queue
attendance_profile
attendance_profiles
campus_list
campus_profile
create_event
create_event_attendance
create_group
create_group_position
create_individual
create_individual_micr
duplicate_individuals_list
event_grouping_detail
event_grouping_insert
event_grouping_list
event_grouping_update
event_profile
event_profiles
execute_advanced_search
execute_search
family_detail
family_list
group_grouping_detail
group_grouping_insert
group_grouping_list
group_grouping_update
group_needs
group_participants
group_positions
group_profiles
group_profile_from_id
group_search
group_type_detail
group_type_insert
group_type_list
group_type_update
individual_attendance
individual_calendar_listing
individual_fit
individual_groups
individual_id_from_login_password
individual_inactivate
individual_profiles
individual_profile_from_id
individual_search
manage_group_leaders
meet_day_detail
meet_day_insert
meet_day_list
meet_day_update
meet_time_detail
meet_time_insert
meet_time_list
meet_time_update
membership_type_detail
membership_type_insert
membership_type_list
membership_type_update
merged_individuals
remove_individual_from_group
update_group
update_group_position
update_individual
valid_individuals