TechClassTechClass Docs

Integrations

Connect your platform with third-party tools and developer APIs.

The Integrations page allows workspace administrators to connect TechClass with external tools, automate workflows, and manage programmatic access to your platform data.

Plan or Add-on Required The features on this page require either the Ultra plan or the Connect+ add-on. If your workspace does not meet either requirement, you will see a locked preview state. Contact our sales team to upgrade your workspace.


Developer API

The Developer API tab provides the essential details needed to authenticate and interact with the TechClass public API.

API Overview

In this section, you will find the core connection details for your integrations:

  • Base URL: The root URL (https://connect.techclass.com/v1) required for all API requests. You can click the copy icon next to the URL to quickly copy it to your clipboard.
  • View API Documentation: Click this button to open the comprehensive TechClass API Reference in a new tab, which includes detailed endpoint schemas, authentication guides, and request examples.

Developer API Tab


Managing API Keys

The API Keys section displays a list of all active and historically revoked keys associated with your tenant.

For security purposes, you are limited to a maximum of 5 Active API keys at any given time. The current usage limit (e.g., 1 of 5 active keys in use) is displayed in the top right corner of the section.

The data table provides the following information for each key:

  • Name: The descriptive label given to the key (e.g., "Zapier Integration" or "HR System Sync").
  • Prefix: The first few characters of the key (e.g., tc_13SY...) to help you identify it without exposing the full secret.
  • Created: When the key was originally generated.
  • Last used: The relative time the key was last used to make a successful API request.
  • Status: Displays whether the key is Active (green) or Revoked (gray).

API Keys Table

Generate a New API Key

To create a new key for an external application or script:

  1. Click the + Generate New Key button.
  2. In the modal, enter a descriptive Key name that clearly identifies what this key will be used for.
  3. Click Generate Key.
  4. Copy your key immediately. You will be presented with the full, plain-text API key.

Generate API Key Modal

Important: For security reasons, the full API key is only displayed once. If you lose it, you will not be able to retrieve it again and will need to revoke it and generate a new one. Store it immediately in a secure vault or password manager.

Revoke an API Key

If an API key is compromised, or if you no longer use the integration it is tied to, you should revoke it immediately. Revoked keys are permanently disabled but remain visible in your table for auditing purposes.

  1. Locate the active key in the data table.
  2. Click the Revoke action on the right side of the row.
  3. A confirmation modal titled Delete API key will appear.
  4. To verify this destructive action, you must type the exact Name of the API key into the confirmation input box (you can use the copy icon above the input to copy the name).
  5. Click the red Delete API key button.

Warning: This action is permanent and cannot be undone. Any external scripts, services, or integrations currently using this key will immediately stop working and return authentication errors.


Email Server

The Email Server tab allows you to configure a Custom Mail Server. By default, TechClass sends all platform emails (such as user invitations, system notifications, and certificates) using our internal mailer.

By enabling the custom mail server, you can route all outgoing system emails through your organization's own SMTP infrastructure. This supports major providers like Office 365, Google Workspace, SendGrid, and any standard SMTP service.

Email Server Tab - Disabled

Configuring Your SMTP Server

To override the default mailer:

  1. Toggle the switch to Enable custom mail server.
  2. Fill in the required SMTP connection details provided by your IT department or email service provider.

Email Server Tab - Enabled

You will need to configure the following settings:

  • SMTP Host: The address of your mail server (e.g., smtp.office365.com or smtp.sendgrid.net).
  • Port: The port used by your server (commonly 587 or 465).
  • Encryption: Select the appropriate security protocol from the dropdown (e.g., STARTTLS or SSL/TLS).
  • Username & Password: The authentication credentials for your SMTP account.
  • Sender Identity:
    • Display Name (Optional): The name recipients will see in their inbox (e.g., "Acme Learning" or "TechClass").
    • From Email: The email address that the messages will be sent from. Note: This exact address must be authorized by your SMTP server to send outgoing mail.

Testing Your Configuration

Before relying on your new custom mail server, it is highly recommended to test the connection to ensure your credentials and port settings are correct.

  1. Once your settings are entered, click the Save Settings button.
  2. Click the Send Test Email button to verify that TechClass can successfully authenticate and dispatch an email through your external SMTP provider.

On this page