> For the complete documentation index, see [llms.txt](https://docs.appmixer.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.appmixer.com/connector-configuration/schoology.md).

# Schoology

### Get your consumer key and secret

Log in to your Schoology server. Look at the top navigation bar and go to *Tools > School Management*.

In the new screen, click on *Integrations* in the left menu. Now click on the API tab. You should see your consumer key and secret. The secret is hidden, so you have to use the *Reveal Existing Secret* option.

<figure><img src="https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-184fe02f86aa322e1c0a5b4e5c5cda28eba51445%2Fschoology-1.png?alt=media" alt=""><figcaption><p>Integrations screen with the consumer key and secret.</p></figcaption></figure>

## Backoffice configuration

Configuration ID: `appmixer:schoology` (Backoffice → Configuration; see [Connector Configuration](https://docs.appmixer.com/getting-started/services) for how a configuration is created and how its keys reach the connector).

* `consumerKey` — Consumer key from *Tools > School Management > Integrations > API* on your Schoology server.
* `consumerSecret` — Consumer secret from the same screen (*Reveal Existing Secret*).
* `domain` — Subdomain of your Schoology server. For example, for *<https://example.schoology.com>* the value is `example`.
* `baseUrl` — Optional. The API base URL. Default `https://api.schoology.com/v1`; set it only when your server uses a different one.

<figure><img src="https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-704dca403cab418c2d41327e3da7e0e6dd2cb2a4%2Fschoology-2.png?alt=media" alt=""><figcaption><p>Configuration values for Schoology</p></figcaption></figure>

The same keys can be set with the CLI (`-u` updates the existing configuration instead of creating it):

```bash
appmixer service-config set appmixer:schoology -u -d '{
  "consumerKey": "<consumer key>",
  "consumerSecret": "<consumer secret>",
  "domain": "<subdomain>"
}'
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.appmixer.com/connector-configuration/schoology.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
