Advanced Info About Trainual's API & Webhooks

What's included in Trainual's current feature version of the API and webhooks?

Trainual's API and webhooks cover four core capability areas — content reading, user management and reporting, groups/responsibilities/assignments, and webhooks.

What Trainual training content can I access through the API?

The API supports full-structured reads of every content type in Trainual: subjects, documents, pages, flowcharts, video links, file links, checklists, tests, and expert-built  courses. This includes the full body/content of each item, not just titles or IDs. A full-text content search endpoint is also available, allowing developers to search across content by keyword.

📝 Please note: Content endpoints (such as creating, writing, or editing content or subjects, documents, or pages via API) are not currently available. But this is on our roadmap. Stay tuned! 🛣️

What can I do with users and user data through the API?

The API supports full user lifecycle management, including:

• Creating users.

• Updating user details.

• Archiving users.

• Unarchiving users.

The API also supports completion and activity endpoints, allowing developers to query things like:

• Who completed specific training content, and when.
• Activity data across the entire organization.

🖼️  Need some users and user data API scenario examples? Check these out...

🔸 API & Webhooks x Users & User Data Example 1:
Need >> I want to programmatically create, update, or archive users, kept in sync across multiple tools.
Solution >> API and webhooks is the right fit — full user lifecycle management is supported, and webhook events fire on user state changes so other systems stay in sync automatically.

🔸 API & Webhooks x Users & User Data Example 2: 
Need >> I want event-driven automation — for example, triggering an onboarding workflow when an assignment is completed.
Solution >> API and webhooks is the right fit — this is a core webhook use case, since webhooks notify another system the instant an assignment is completed.

What can I do with groups, responsibilities, and assignments through the API?

• The API supports full CRUD (create, read, update, delete) operations for all group types in Trainual: Roles, Teams, Departments, Locations, and others (others being the ones you custom created inside of Trainual).

• Individual user responsibilities are fully manageable through the API.

• View, create, and delete training assignments for individual users.

What can I do with Trainual's webhooks?

There are a variety of distinct event types that span:

• Content lifecycle changes.

• User state changes.

• Group membership changes.

• Completions.

• Assignments.

Webhook syncs can be created, managed, tested, and inspected both through the API and within the Trainual app UI.

Need a webhook scenario example? Check this out...

🔸 Webhook Example 1: 
Need >> I need to pull completion data into a business intelligence (BI) tool or data warehouse."
Solution >> API and webhooks is the right fit — completion endpoints support pulling this data, and webhooks can trigger a sync the moment a completion happens.

🛡️ Security note on webhooks: All webhook payloads are HMAC-signed, allowing customers to verify that a payload genuinely came from Trainual.

🐛 Debugging note on webhooks: Webhooks include delivery logs and support redelivery, so customers can troubleshoot failed or missed webhook events.

FAQs:

My team uses Smartsheet, and we are looking to connect that to Trainual. How can I achieve this?
Your developer or tech team can look into building custom connections using Trainual’s API and webhooks alongside Smartsheet’s own API. 

Every setup is a little different, so I can’t speak to specific build questions — but here’s some documentation that should help you identify whether what you’re trying to do is possible:

• developers.smartsheet.com

• developers.trainual.com