Skip to content
English
  • There are no suggestions because the search field is empty.

Trainual's API & Webhooks

Learn how to build custom connections between Trainual and other systems using Trainual's API and webhooks.

Great tools play well with others, and Trainual is no exception. Move your content and data, automate updates, and keep systems in sync using Trainual's API and webhooks.

API + Webhooks Beamer image
👉 Before you start:

  • Trainual's API and webhooks are available under:
  • Only those with an Admin+ permission level can create API tokens.
  • This info is best suited for teams ready to go hands-on with code. Access to or partnership with a developer or tech person is recommended.
  • ⚠️ Existing API connected customers: Trainual's API was updated on July 10th, 2026, with new access capabilities. The previous version is scheduled to be phased out by the end of 2026. To avoid disruptions, update your connections. 

🗂️ Table of contents: Skip around to just the parts you need with these links.

 

Overview: API and webhooks — what are they? 

An API (or application programming interface) is how one piece of software is able to "talk" to another. Think of it as your custom-built tech messenger saying: "Hey Trainual, give me this," or "Hey Trainual, update that" when it's requested.

🖼️ API Examples:

By contrast, a webhook serves as a type of automatic "notification." Trainual's way of saying "this just happened" to your connected tech instantly, instead of "waiting to be asked" like with an API. Webhooks mainly trigger specific connected workflows when linked changes happen inside of Trainual.

🖼️ Webhook Examples:
  • "The moment a user completes the onboarding subject, fire an event to our HRIS to mark the onboarding as done."
  • "When new content is published, notify our internal AI so it re-indexes its knowledge base."
  • "When a user is archived in Trainual, trigger our SSO system to disable their user account."

When used together, they can cover both directions — the API lets you reach in and grab what you need, while webhooks reach out the moment something new happens, so your syncs can work in tandem to go even deeper! 🤩

Not sure if these connections make sense for your team? 👀 This article will help you decide, and hand you the resources to get set up, if they do fit. Let's see if...




Are API and webhook connections the right fit? 

🏁 Start by narrowing down what you're trying to accomplish. Ask questions like...

Think of this brainstorming session as step one (identifying the what), and looping in your developer as step two (figuring out and building the how).

When you're ready to rope in a tech team, the info below is what they'll need. 🤓


Resources to get you plugged in:

1️⃣ Developer documentation → The technical details.

📑 This is the critical resource to hand off to whoever's building your connections.

It walks through exactly how to authenticate, which endpoints are available, and what to expect from every request (AKA, what's needed to build and maintain syncs).

2️⃣ In-app → How to create a Trainual API token.

🔹 Step 1: Locate the API token creation button in Trainual. 

  1. Click on your avatar from your top navigation bar.

  2. Select "My settings."

  3. Locate the "API Tokens" section.

  4. Hit the "+ Create new token" button.

📝 Please note: Tokens operate on behalf of the user who creates them and inherit that user’s permissions. Keep this in mind when setting API token permissions.

🔹 Step 2: Name your API token.

Easily identify your tokens by naming them after the tool or agent it connects to and its function. You may end up with multiple tokens over time, so clear names matter here!

🔹 Step 3: Select your API token permissions.

Choose the data your token can access.

🔑 Token permission: 🔓 What it unlocks:
Access users. Create, view, update, archive, and restore individual users.
Access groups. Create, view, and update groups, including their members and assigned training content.
Access responsibilities. Create, view, delete, assign, and remove responsibilities for individual users.
Access assignments. View, create, and delete training assignments for individual users. 
Access completions. View training completion records across the account, by user, or by subject.
Access content.

View and search published training content across your Trainual account.

📝 Please note: Content creation and editing aren't supported by the API yet. Select "Edit" when creating your token to have that access ready when it's launched.
Access webhooks. Create, update, delete, test, and monitor webhooks, including delivery logs and signing secret validation.
Access MCP tokens. Issue, revoke, and rotate tokens that let AI agents authenticate and access training content.
Access activities. View activity data for a specific user or across the entire Trainual account.

📝 Please note: 

  • API token access can't be altered once created. Changes require a new token.
  • Tool options are shown based on what you have access to as an individual user.

 

3️⃣ In-app → How to create a Trainual webhook event.

🔹 Step 1: Locate the "Create webhook" button in Trainual. 
  1. Expand the "Account" options from the left-hand navigation menu.
  2. Choose "Settings."
  3. Open the "Developer" tab.
  4. Hit the "Create webhook" button to begin. 

🔹 Step 2: Fill out the basics about your webhook in the pop-up window.
  1. Name your webhook something clear and concise.
  2. Select the endpoint URL (HTTPS is mandatory).
  3. Check off specific, individual events or choose "Select all events."
  4. Hit the "Create webhook" button to be granted a signing secret and be redirected to a place to send a test event.

📝 Please note: You can create up to 10 webhook utilizations per user account, each one supporting all available event connections.


And that's your basic toolkit! 🧰 You and your tech-savvy people are ready to start putting Trainual's API and webhooks to work. 🏗️


Tools that connect well with Trainual's API and webhooks:

While not an extensive list, here are a few examples of tools that sync well with Trainual!

Claude (Anthropic): Connects your external AI assistant or agent directly to your Trainual content, so it can pull from and act on your training data.

Postman: The developer tool used to test your Trainual API connection.

Google Cloud (BigQuery): Pulls your Trainual data into a data warehouse for deeper reporting and analysis.

n8n: A workflow automation tool that react to webhook alerts from Trainual.

Looker: A dashboard builder that uses your Trainual completion and activity data as a foundation.

Make: An automation tool that can trigger workflows the moment something happens in Trainual.


FAQs: 

Will Trainual build a custom API integration for me? 
Trainual doesn't build custom integrations for customers, but our full developer documentation has everything a tech person would need to get started.


Can I set up an API integration to create or edit training content?
Not yet. But this is on our roadmap. Stay tuned! 🛣️


What authentication method does Trainual's API use?
Bearer API tokens.


What are Trainual's API rate limits?
100 requests per 5 seconds per account and 200 requests per 5 seconds per IP address.


What's the difference between Trainual's API and webhooks vs. the MCP server?
API and webhooks are a standard and flexible way for developers or tech savvy teams to write code that pulls from or updates data in Trainual via externally connected systems. The Trainual MCP server skips the coding and lets your AI tools connect directly to Trainual to search and retrieve content, data, etc. autonomously.


How can I submit my feedback and ideas about features?
If you'd like to share your thoughts about Trainual's API or think of something else you'd like to see added in the future, send us your feature requests and ideas.


Learn more about Trainual integrations and automations:

  • Harness the power of Trainual, without having to leave Slack.
  • Integrate your existing HR or payroll system to quickly import info to Trianual.
  • Easily connect your Trainual account to thousands of other apps using Zapier.