How do I use Shortcuty's version checking system in my shortcut?

What is the Shortcut Updater Tool?

The Shortcut Updater Tool is a feature in the Shortcuty iOS app that automatically adds update-checking code to your shortcuts. It downloads your shortcut from iCloud, injects the updater mechanism, and returns a ready-to-use shortcut file.

How to Access:

• iOS App: Open the Shortcuty iOS app → Navigate to "My Shortcuts" → Select a shortcut you've uploaded → Tap "Developer Tools" → Select "Auto-Updater Tool"
• Web Version: Go to "My Shortcuts" on the website → Click "Developer Tools" on a shortcut → Select "Auto-Updater Tool"

Note: The Auto-Updater Tool is available in Developer Tools on both the iOS app and web version for shortcuts you've uploaded.

How It Works:

1. The tool downloads your shortcut from iCloud using the sharing URL
2. It automatically injects the appropriate update-checking mechanism
3. You receive a processed shortcut file ready to install
4. Replace your original shortcut with the processed version

Template Options:

• API Template: Uses native URLs (Get Contents of URL) - works on any device without the Shortcuty app installed
• Action Template: Uses the "Check Shortcut Update" action - requires Shortcuty app installed on user devices

Benefits:

• No manual coding required
• Handles version comparison logic automatically
• Supports semantic versioning (1.2.3)
• Works with both native URLs and Shortcuty actions

Method 1: Using Check Shortcut Update Action

This method uses Shortcuty's built-in action for update checking. It requires the Shortcuty app to be installed on user devices.

Implementation Steps:

1. Add the "Check Shortcut Update" action to your shortcut
2. Provide your shortcut's UUID (found in "My Shortcuts" in the Shortcuty app)
3. Provide the current version number of your shortcut
4. Add an "If" statement after the check
5. If the result is true (update available):
   • Add "Open App" action → Select "Shortcuty"
   • Add "Stop Shortcut" action

Requirements:

• Shortcuty app must be installed on user devices
• Shortcut must have a UUID (obtained after submitting to Shortcuty)

Benefits:

• Simplest manual implementation
• Automatic version comparison
• App automatically shows update screen when update is available

View Check Shortcut Update action documentation →

Method 2: Using Native URLs

This method uses standard Shortcuts actions and works on any device, even without the Shortcuty app installed.

Get Your URLs:

• Open "My Shortcuts" in the Shortcuty iOS app
• Select your shortcut
• Find the "Version" URL and "Download Link" URL
• Copy these URLs for use in your shortcut

Implementation Steps:

1. Add "Get Contents of URL" action
2. Set the URL to your version endpoint (returns current version as plain text)
3. Store the result as "Latest Version"
4. Add "If" statement
5. Condition: Latest Version > Current Version
6. If true:
   • Add "Open URL" action
   • Set URL to your download link endpoint
   • Add "Stop Shortcut" action

Requirements:

• Shortcut must have a UUID (obtained after submitting to Shortcuty)
• No additional apps required

Benefits:

• Works on any device without Shortcuty app
• Uses only native Shortcuts actions
• Full control over update flow

Semantic Versioning

Shortcuty supports semantic versioning (e.g., 1.2.3) for version comparison. The system compares versions numerically, so 1.2.3 is considered newer than 1.2.2, and 2.0.0 is newer than 1.9.9.

Version Comparison Logic

The system compares version strings by splitting them into components and comparing each part numerically. This ensures accurate version ordering regardless of string length.

Update Notifications and Tracking

When shortcuts check for updates using Shortcuty's version checking API:

• Version checks are automatically tracked for analytics
• Developers can see version check statistics in their analytics dashboard
• This helps estimate active users of your shortcuts
• Anonymous usage statistics are collected server-side

Analytics Integration

Version checks contribute to your shortcut's analytics:

• Track how many users are actively using your shortcuts
• Monitor update adoption rates
• Identify which versions are still in use
• View version check trends over time

Best Practices

• Always use semantic versioning (major.minor.patch format)
• Place update checks at the beginning of your shortcut
• Use "Stop Shortcut" after opening the update URL to allow installation
• Test update checks with different version numbers before releasing
• Keep your shortcut's UUID and version number easily accessible for updates

Returns the approved changelog history for a shortcut.

https://shortcuty.app/api/shortcuts/00000000-0000-0000-0000-000000000000/changelog

{
  "shortcut_name": "My Shortcut Name",
  "changelog": [
    {
      "version": "1.2.0",
      "changelog": "Fixed critical bug in data processing",
      "date": "2024-01-15T10:30:00Z"
    },
    {
      "version": "1.1.0",
      "changelog": "Added new feature for better performance",
      "date": "2024-01-10T08:15:00Z"
    }
  ]
}

{
  "error": "Shortcut not found"
}

Documentation Links

• Actions Documentation - Complete guide to all Shortcuty actions
• Check Shortcut Update Action - Detailed action documentation
• Public API Documentation - REST API reference for version endpoints
• What is Shortcuty? - Overview of Shortcuty's features