Integration

Custom Server Integration

If you host the shortcut by yourself, you will need to setup your server accordingly.

After setting it up, just add the required keys to the dictionary action inside your shortcut, Swing Updater is now able to check for updates for you!

Key	Type	Required	Description
Name	Text	Yes	The name of the shortcut to be used in notifications and the update prompt.
Version	Text	Yes	The current version of the shortcut.
Server	Text	Yes	The URL of your Custom Server that should be used by Swing Updater.
Message	Boolean	No	Must be `true` if you want your users to get an alert informing if there's no updates available for your shortcut.
Icons	Dictionary	No	A dictionary containing the icons to be used on the update prompt. Check Personalization for more info.
Timeout	Number	No	The amount (in minutes) between consecutive updates. This should improve your shortcut speed as this prevents multiple update checks in a short time span.
Channel	Text	No	The name of the channel to check for updates from. This key works alongside the `Catalog` key.
Catalog	Dictionary	No	The list of available update channels that can be selected using the `Channel` key. Check Pre-release Updates for more info.
Return	Any	No	When any value is assigned to this key, Swing Updater will check for updates and return the information to your shortcut with no prompts shown to the user.