Get Started

When and how to integrate with Skillhabit over HTTPS—keys, users, sign-in links, and where to find each resource.

What This Is For

The External API lets your own systems talk to Skillhabit over HTTPS: create and update users, manage groups and access, discover content, assign learning, read progress, and open Skillhabit for a person with a pre-signed login link.

It is the right tool when your HR, CRM, portal, or middleware owns the integration—not when you only need people to sign in with Microsoft or Magic Links.

Interactive request and response shapes live in the External API reference. This section teaches when, why, and how to use the API. It does not list every endpoint.

Who This Is For

Workspace administrators who enable the feature and create API credentials, working with integration developers who call the API from a trusted backend.

Treat every API key like a password. Do not put keys in front-end apps or public repos.

Before You Start

Confirm the External API capability is enabled for your account. If Configure → Connections → API Credentials says it is not available, contact Skillhabit.
Create an API key (API Credentials). You can have up to three active keys. Copy the secret when it appears—Skillhabit shows it only once.
Decide how each user will sign in later (Magic Links, Microsoft, OpenID Connect, or an External API login link). Sign-in setup is separate from the API key: SSO and Authentication.
Keep a small test user or group ready so you can verify create, update, and login-link flows safely.

Product steps for keys: API Keys.

Authenticate Every Request

Send your API credential as a bearer token on each call:

Authorization: Bearer {your-api-credential}

That authenticates your backend to Skillhabit. It is not the same as signing a person into the product UI—see the login-link flow below.

Create a User and Open Skillhabit

A common portal pattern:

Create the user with the Users resource if they are not already in Skillhabit (or look them up if Entra, SCIM, or an admin already provisioned them).
Call Create sign-in link (POST /auth) with userId or email (userId wins if both are sent). Optionally pass redirectUri as a query parameter for where to continue after login.
Open the returned pre-signed link for that person (or hand it off from your portal). The link includes a login secret and expires at the returned timestamp.

Copy-paste recipe: Create a User and Sign-In Link.
Sign-in context: SSO and Authentication → External API User Authentication.
Endpoint shapes: API reference → Users and Authentication.

Examples

Job	Recipe
Create a user and open Skillhabit	Create a User and Sign-In Link
Keep HR departments as Skillhabit groups	Sync Manual Groups
Assign a course to a group	Assign Content to a Group

All recipes: Examples.

Users Without a Real Email

Every Skillhabit user needs an email-shaped identifier. You do not need a real mailbox.

Use a unique address on @noemail.skillhabit.com (for example partner-user-17@noemail.skillhabit.com). Skillhabit never sends invitations, reminders, or other system email to that domain.

That pattern fits integrations that create users and sign them in with the API (or SSO) when email is unused. Magic Links will not work for those addresses—plan Microsoft, OpenID Connect, or an External API login link instead.

Delivery rules: Bulk Actions and Email.

Main Resources

Use this map to pick a job, then open the matching tag in the interactive reference for paths and schemas.

Job	OpenAPI tag	Start here
Create a pre-signed login link for an existing user	Authentication	SSO and Authentication
Read workspace settings (domains, company name, language)	Workspace	Early in an integration for customer context
List, search, create, update, or archive users	Users	User Provisioning
Grant or revoke admin, manager, or app access	User Access	After the user exists
Read certificates already issued to users	User Certificates	Reporting / HR exports
Manage manual groups and membership	Manual Groups	Departments and cohorts you assign by hand
Manage rule-based groups from custom fields	Smart Groups	Membership that follows attributes
Define or read custom user attributes	Custom Fields	Smart groups and profile data
Discover courses, programs, SCORM, meetups	Content Catalog	Before assigning or selling content
Assign or remove content visibility / mandatory targets	Content Targeting	Same orchestration idea as Create visibility
Register or update content purchase state	Purchases	Commerce integrations
Query participation results and aggregates	Analytics	Progress reporting outside Analyze
Start manager-driven certificate / participation generation	Certificate Management	Manager workflows from an integration

Timestamps in the reference that are documented as epoch milliseconds use UTC.

Webhooks (Outbound)

The External API is your system → Skillhabit. Webhooks are the other direction: Skillhabit pushes events to your HTTPS endpoint when learning progresses, courses change, or meetups update.

Configure them in product under Configure → Connections → Webhooks. Pedagogy and event catalog: Webhooks. Product steps: Configure → Webhooks. OpenAPI sidebar: Webhooks.

Need	Guide
Entra sync, SCIM, or API as the owner of user lifecycle	User Provisioning
How people sign in (including API login links)	SSO and Authentication
Create and rotate API credentials in Configure	API Keys
Interactive OpenAPI explorer	External API reference

Get Started

On this page