URL Commands allow you to open iA Writer from other applications on both macOS and iOS, and perform specific actions on opening.
For example, you can turn a text snippet into a new iA Writer document. URL Commands can also be used to change some of iA Writer’s defaults.
On iOS, these URL Commands can be leveraged with the iOS Shortcuts app. (iOS 12+).
Starting from scratch you can put together a URL-scheme with 3 key building blocks. The following workflow should work for novice and seasoned users alike:
Choose Command →
Add Parameters →
By selecting the appropriate command from the list below, you can quickly get a feel for what parameters and values will be necessary for your own URL.
The general structure of a special URL will resemble:
All commands can support x-callback-url. This comes in handy when you want to send or receive information to/from another app.
The structure for a url including x-callback:
Some commands will return parameters on
Commands that allow you to interact with iA Writer. Select Details tab to see more details and an example of each command.
Opens Editor with an existing document.
Opens EXAMPLES.txt (file) which is saved in iCloud → Website → URL-Commands (folder)
Opens Editor with a new document.
Creates a new file titled entry123.txt in iCloud → Journal (folder)
Opens Quick Search with a given query.
Opens a Quick Search window for terms “#unfinishedtask”
# symbol needs to be percent encoded →
Silently read and write data to/from iA Writer. Handy for: external apps interacting with iA Writer.
Reads and returns files contents.
Creates or modifies an existing file and returns file contents.
createDefault. Adjusts last path component to avoid replacing an existing file.
replaceReplaces an existing file.
appendAppends the given text to an existing file.
beginningAppend text at the beginning of a file.
endDefault. Append text at the end of a file.
true. Make a paragraph out of appended text. Used only when
Appends the term “LOG COMPLETE” in a new paragraph at the end of document entry123.txt found in iCloud → Journal
Returns iA Writer app version and URL scheme version.
Learn more and see examples of the various data types your URL-scheme may call for.
Alice%27s%20Diarywhere the invalid characters (apostrophe and space) are replaced with
/this leading slash refers to the default location (iCloud or local).
/Locations/From Other Apps/is available on iOS.
/Locations/Name/can be used to filter files from custom locations on macOS.
Tester's Folder, found within the default iCloud folder. →
Learn more about why some commands require an Auth-token.For privacy and security, commands that modify or return data using x-callback-url require the
auth-token parameter. This Auth token is synced across all your devices using iCloud. This can be found in:
🔆 If you reset your auth-token you will need to replace this parameter in any x-callback-urls you’ve previously created.
Get StartedWe wanted to share these in-house Shortcuts created for iOS(12+) users!
In adding these to your Shortcut library you will have not only handy Shortcuts but also something you can refer to or modify to your own liking.
Note: If you have not enabled Allow Untrusted Shortcuts in iOS settings → Shortcuts, you will be prompted to do so when trying to add these Shortcuts.
Here are some things you can do if iA Writer acts in unexpected ways.
Below are answers to common questions. Everyone is special, but most questions that we get overlap.
iA Writer is file storage provider agnostic but we recommend iCloud for the best experience across most devices:
Lost progress in a document? Regret deleting that paragraph? No problem!
Whenever possible, troubleshooting steps are listed here for iA Writer Classic on macOS & iOS and Writer 1.5.2 for Android.
Scroll through the history of our apps, version by version, platform by platform, update by update.
Which information do we see, and what do we leave untouched?
We want our products to be enjoyed by the widest possible audience.
Open iA Writer from other applications on both macOS and iOS, and perform specific actions on opening.