Configure Connection
Schoology guide
Generate Schoology API credentials, enter them in NIM, and collect data to validate access before enabling user, group, or course automation.
Before you beginDirect link to Before you begin
Review the Schoology API authentication documentation. Sign in as a system administrator with the Access Schoology API permission to obtain consumer credentials.
NIM requires Client Key and Client Secret.
Test Connection always reports success for this connector. It does not validate credentials or API access. Perform a system collection to test the connection.
Request a consumer key and secretDirect link to Request a consumer key and secret
-
Sign in to Schoology as a system administrator.
-
Open your school's API page by appending
/apito its Schoology URL. For example:https://<YOUR_SUBDOMAIN>.schoology.com/apiAlternatively, go to Tools > School Management > System Settings, select Integrations in the left sidebar, and open the API tab.
-
Select Request NEW API Key.
-
Copy the displayed Consumer Key and Consumer Secret, and store them securely for NIM.
Enter the connection settingsDirect link to Enter the connection settings
- In NIM Studio, open Systems > Overview and add a Schoology system, or select the existing system.
- Open Connection, enter the following settings, and save.
| NIM setting | Value |
|---|---|
| Client Key | The Consumer Key generated in Schoology. |
| Client Secret | The corresponding Consumer Secret. |
Verify API access by collecting dataDirect link to Verify API access by collecting data
- Perform a system collection in NIM. A successful Test Connection result alone does not verify access.
- Confirm that collection completes and inspect the users, groups, courses, sections, and enrollments required by your process.
- If collection fails, review the error and verify the Client Key, Client Secret, network access, and API account permissions.
- Validate user matching and group, course, and enrollment mappings. Test each intended write operation with safe records before enabling automation.
A successful collection verifies the selected reads. Validate permissions for provisioning and other write operations separately.