Northpass

Welcome to the Northpass Developer Hub!

The Northpass platform was purpose-built for developers to flex their creative muscles. Discover what's possible with our solution so that you can deliver the most impactful experiences within your products.

Start by browsing our guides to learn how to best interact with our APIs. Then, dive into our API Reference to see what's possible.

Get Started    API Reference

What are Properties?

Properties are used to store data within the School, Course, and Person namespaces. They allow you to bring your own data into Northpass to create tailored learning experiences, simplify content management, and drive automated workflows.

Creating a Property in a namespace allows you to specify a value for each individual object or instance in the namespace. For example, creating a Property called Country in the Person namespace allows you to specify the country of each person in your Northpass school:

Person

Country

Ken Miller

United States

Tamara Smith

England

Rebecca Williams

France

Adam Jones

Canada

Conditional Properties

Conditional Properties are data mappings that derive their value based on the value of a referenced Property. These are very powerful when your data is segmented and you do not want to write the logic for managing the data mappings yourself. Building off of the example above, a Conditional Property for Currency might look like this:

Country

Currency

United States

USD

England

GBP

France

EUR

Canada

CAD

If the Currency property is used in a course, it will derive its value based on a person's Country property value. This means that USD will be returned as the value for anyone in the country of the United States.

With only four records, this is a trivial example. In a realistic scenario, you may have thousands of people in your environment, and Conditional Properties will greatly simplify data management.

Updated 28 days ago


What's Next

Now that you know what Properties are, keep reading to learn how to create Property definitions.

Creating Property Definitions

What are Properties?


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.