Mitzvah Tools: Set Up ShulCloud API (How to and Reference)

Before You Begin

An email address must be entered in ShulCloud for at least one parent for every student that will be imported with the API.

A Bar/Bat Mitzvah date must be entered in ShulCloud for every student that will be imported with the API:

1. Navigate to Accounts > People. 
2. Search for the student's name.
3. Select Edit in the row with the student's name.
4. Select the Lifecycles tab.
5. Add the Bar/Bat Mitzvah Date and any additional information.
6. Select Save.

Set Up API in ShulCloud

1. Navigate to Admin > My Lists > SC API Keys.
2. Select Add New.
3. Enter a Name/Use for the API - for example, "Mitzvah Tools."
4. In the Access To dropdown, select accountList.
5. Scroll to the bottom of the page and select Create New.

When the API is created, it will appear in the menu under API Keys. The Key and Secret fields will be used to connect with Mitzvah Tools.

In the example below, the API keys are for training purposes and will not work in a live site. The actual ShulCloud API will be longer and more complex.

Enter API Keys in Mitzvah Tools

1. In Mitzvah Tools, navigate to Program Settings > General Settings.
2. Enter the ShulCloud API Key and the ShulCloud API Secret from the Mitzvah Tools API in ShulCloud. In the example below, the API keys are for training purposes and will not work in a live site. The actual ShulCloud API will be longer and more complex.
3. Select Save.

Import Students Using the API

1. In Mitzvah Tools, navigate to Students > Import Students.
2. Enter the Start Date and End Date for the range of B'nai Mitzvah Dates to be imported.
3. Select Find Students.
4. A list of students eligible for import will load at the bottom of the page.
5. Select the check box to the left of any that should be imported.
6. Select Import Selected at the top right of the page.
7. Once a student is imported, a red X will appear next to their name in the list. This student cannot be re-imported with the API.

Note: If any information is incorrect in the list of students, it must be corrected in ShulCloud before importing. Once the information is corrected, re-enter the dates and re-select Find Students to view the corrected information.

Review Students

1. In Mitzvah Tools, navigate to Students.
2. Search for the imported student names, and select Edit Profile to review account details.

Related Resources

•