Tutorial
A step-by-step instructional tutorial with progress tracking, completion metrics, and learning outcomes for customer education.
Tutorial
A step-by-step instructional tutorial with progress tracking, completion metrics, and learning outcomes for customer education.
Properties
id(string): Unique identifier for the tutorial.title(string): Tutorial title.description(string): Detailed description of what the tutorial teaches.summary(string): Brief summary for listings and previews.category(string): Tutorial category (getting-started, advanced, integration, feature).subcategory(string): More specific classification.difficulty(string): Difficulty level (beginner, intermediate, advanced, expert).duration(number): Estimated completion time in minutes.product([[Product]]): Related product or service.steps([[TutorialStep]][]): Sequential steps in the tutorial.prerequisites([[Tutorial]][]): Tutorials that should be completed first.learningObjectives(string[]): What users will learn by completing this tutorial.outcomes(string[]): Expected outcomes after completion.tags(string[]): Tags for categorizing and filtering.language(string): Language code (en, es, fr, etc.).translations([[Translation]][]): Available translations of this tutorial.videoUrl(string): URL to tutorial video if available.videoDuration(number): Video duration in seconds.interactiveDemo(string): URL to interactive demo or sandbox.codeExamples([[CodeExample]][]): Code snippets and examples.resources([[Resource]][]): Additional learning resources.relatedTutorials([[Tutorial]][]): Other tutorials commonly viewed together.relatedGuides([[Guide]][]): Related how-to guides.relatedFAQs([[FAQ]][]): Related frequently asked questions.status(string): Tutorial status (draft, published, archived, outdated).author([[User]]): User who created the tutorial.lastReviewer([[User]]): User who last reviewed the tutorial.reviewDate(number): Timestamp of last review (Unix timestamp).completionCount(number): Number of users who completed the tutorial.startCount(number): Number of users who started the tutorial.completionRate(number): Completion rate (percentage).averageRating(number): Average user rating (0-5).ratingCount(number): Number of ratings received.averageCompletionTime(number): Average time to complete in minutes.dropoffRate(number): Percentage of users who drop off (0-100).mostCommonDropoff([[TutorialStep]]): Step where users most commonly drop off.created(number): Timestamp when tutorial was created (Unix timestamp).updated(number): Timestamp when tutorial was last updated (Unix timestamp).published(number): Timestamp when tutorial was published (Unix timestamp).metadata(object): Set of key-value pairs for storing additional information.
Actions
create
Create a new tutorial.
Input: [[Tutorial]]
Output: [[Tutorial]]
update
Update tutorial content or structure.
Input: [[Tutorial]]
Output: [[Tutorial]]
delete
Permanently remove the tutorial.
Input: [[Tutorial]]
Output: [[Tutorial]]
publish
Publish the tutorial for public access.
Input: [[Tutorial]]
Output: [[Tutorial]]
unpublish
Unpublish the tutorial.
Input: [[Tutorial]]
Output: [[Tutorial]]
archive
Archive outdated tutorial.
Input: [[Tutorial]]
Output: [[Tutorial]]
addStep
Add a step to the tutorial.
Input: [[TutorialStep]]
Output: [[Tutorial]]
removeStep
Remove a step from the tutorial.
Input: [[TutorialStep]]
Output: [[Tutorial]]
reorderSteps
Reorder the sequence of steps.
Input: [[StepOrder]][]
Output: [[Tutorial]]
translate
Add translation in another language.
Input: [[Translation]]
Output: [[Tutorial]]
trackStart
Record when user starts the tutorial.
Input: [[TutorialProgress]]
Output: [[TutorialProgress]]
trackProgress
Track user progress through steps.
Input: [[TutorialProgress]]
Output: [[TutorialProgress]]
trackCompletion
Record when user completes the tutorial.
Input: [[TutorialProgress]]
Output: [[TutorialProgress]]
rate
Add user rating for the tutorial.
Input: [[Rating]]
Output: [[Tutorial]]
suggest
Suggest relevant tutorials for a user.
Input: [[User]]
Output: [[Tutorial]][]
analyze
Analyze tutorial performance and engagement.
Input: [[Tutorial]]
Output: [[TutorialAnalytics]]
Events
created: Triggered when a new tutorial is created.updated: Triggered when tutorial is modified.deleted: Triggered when tutorial is deleted.archived: Triggered when tutorial is archived.published: Triggered when tutorial is published.unpublished: Triggered when tutorial is unpublished.started: Triggered when user starts the tutorial.completed: Triggered when user completes the tutorial.abandoned: Triggered when user abandons the tutorial.rated: Triggered when user rates the tutorial.Step.added: Triggered when a step is added.Step.completed: Triggered when user completes a step.Step.removed: Triggered when a step is removed.Step.skipped: Triggered when user skips a step.Translation.added: Triggered when translation is added.