Let iOS apps talk
A user contributable directory of iOS apps with x-callback-urls. Learn more or See the apps.
Is an app / URL missing? Did you find an error? Help me keep the documentation up-to-date. See how to contribute.
Jump to app
All apps (61)
Agenda
Airmail
Awair
Bear
beorg
Bitly
Blackbox
Byword
Calca
Chrome
Coda
CodeHub
Copied
Day One
DEVONthink To Go
dict.cc
Drafts 5
Due
Fantastical 2
Forward SMS
Genshin Impact
Gladys
Gmail
Google Maps
iCab Mobile
IFTTT
Infuse
Instapaper
Launcher
Lovense Remote
MultiTimer
myQ Garage & Access Control
Notes
OmniFocus 3
1Writer
Opener
Outlinely
Overcast
Price Tag
Prizmo Go
Pyto
RunJavaScript
Scriptable
Shopi
Shortcuts
Spark
Story Planner
Tally 2
Terminology
Textastic
Textkraft
Things 3
Timepage
Todoist
Trello
2Do
Ulysses
VLC
Workflow
Working Copy
WOWidget
App details
Open ”On the Agenda”
Open the On the Agenda overview.
agenda://x-callback-url/on-the-agenda
Open ”Today”
Open the Today overview.
agenda://x-callback-url/today
Open project
Open a project. Identified by title or identifier.
agenda://x-callback-url/open-project
?title=
The title to search for.
&project-title=
The project title to seach for.
&identifier=
The identifier of a project.
&x-success=
Your x-success callback will be called with the following parameters
Open note
Open a note. Identified by title or identifier.
agenda://x-callback-url/open-note
?title=
The title to search for.
&project-title=
The project title to seach for.
&identifier=
The identifier of a note.
&x-success=
Your x-success callback will be called with the following parameters
Create note
Create a note. In the given project. (title or identifier)
agenda://x-callback-url/create-note
?title* =
The title of the note.
&text* =
The text of the note.
&project-title=
The project title to add the note to.
&identifier=
The identifier of the project to add the note to.
&date=
Natural language or absolute dates.
&start-date=
Natural language or absolute dates.
&end-date=
Natural language or absolute dates.
&attachment=
base64 encoded data with no line breaks.
&filename=
The filename of the attachment, including file extension.
&x-success=
Your x-success callback will be called with the following parameters
Append to note
Append text or an attachment to a note, or change the title or date
agenda://x-callback-url/append-to-note
?text* =
The text of the note.
&on-the-agenda* =
&title=
The title of the note.
&project-title=
The project title.
&identifier=
The identifier of the note.
&date=
Natural language or absolute dates.
&start-date=
Natural language or absolute dates.
&end-date=
Natural language or absolute dates.
&attachment=
base64 encoded data with no line breaks.
&filename=
The filename of the attachment, including file extension.
&x-success=
Your x-success callback will be called with the following parameters
compose
Open a new email draft in Airmail
airmail://compose
?subject=
Enter the subject line for the new email message.
&from=
Enter the email address that you want to send the message from.
&to=
Enter the email addresses--separated by commas--for the To field of the new email message.
&cc=
Enter the email addresses--separated by commas--for the Cc field of the new email message.
&bcc=
Enter the email addresses--separated by commas--for the Bcc field of the new email message.
&plainBody=
Enter the content of your new email message in plain text.
&htmlBody=
Enter the content of your new email message in HTML.
List
Opens the Device List view
awair://list
Score
Opens the Awair Score tab
awair://score
Tips
Opens the Tips tab
awair://tips
Trend
Opens the Trend tab
awair://trend
?deviceType* =
The model name
&deiviceId* =
numeric identifier of the device
&component* =
Sensor Component
×tamp* =
of the format: 2017-04-12T23:22:00.000Z
Awair+
Opens the Awair+ tab
awair://awairplus
Notifications
Opens the Inbox tab
awair://notifications
Open Note
Open a note identified by its title or id and return its content.
bear://x-callback-url/open-note
?id=
note unique identifier.
&title=
note title.
&exclude_trashed=
if ”yes” exclude trashed notes.
&x-success=
Your x-success callback will be called with the following parameters
Create Note
Create a new note and return its unique identifier. Empty notes are not allowed.
bear://x-callback-url/create
?title=
note title.
&text=
note body.
&tags=
a comma seperated list of tags.
&pin=
if ”yes” pin the note to the top of the list.
&file=
base64 representation of a file.
&filename=
file name with extension. Both ”file” and ”filename” are required to successfully add a file.
&open_note=
if ”no” do not display the new note in Bear’s main or external window.
&x-success=
Your x-success callback will be called with the following parameters.
Add Text
Append or prepent text to a note identified by its title or id.
bear://x-callback-url/add-text
?id=
note unique identifier.
&title=
title of the note.
&text=
text to add.
&mode=
the allowed values are ”prepend”, ”append”, ”replace_all” and ”replace”
&exclude_trashed=
if ”yes” ecxclude trashed notes.
&open_note=
If ”no” do not display the new note in Bear’s main or external window.
Add File
Append or prepend a file to a note identified by its title or id.
bear://x-callback-url/add-file
?id=
note unique identifier.
&title=
note title.
&file=
base64 representation of a file
&filename=
file name with extension. Both file and filename are required to successfully add a file.
&mode=
the allowed values are
&open_note=
If ”no” do not display the new note in Bear’s main or external window.
&x-success=
Your x-success callback will be called with the following parameters.
Open Tag
Show all the notes which have a selected tag in bear.
bear://x-callback-url/open-tag
?name=
The tag name.
Rename Tag
Rename an existing tag.
bear://x-callback-url/rename-tag
?name=
The tage name.
&new_name=
The new tag name.
Delete Tag
Delete an existing tag.
bear://x-callback-url/delete-tag
?name=
The tage name.
Trash
Move a note to bear trash.
bear://x-callback-url/trash
?id=
note unique identifier.
Search
Show search results in Bear for all notes or for a specific tag.
bear://x-callback-url/search
?term=
String to search.
&tag=
Tag to search into.
Grab URL
Create a new note with the content of a web page.
bear://x-callback-url/grab-url
?url=
URL to grab.
&images=
If ”yes” grab the pages images
&tags=
a comma separated list of tags.
&pin=
if ”yes” pin the note to the top of the list.
&x-success=
Your x-success callback will be called with the following parameters.
Change Theme
Change the selected Bear theme. Some themes may require a Bear Pro subscription.
bear://x-callback-url/change-theme
?theme=
Available values
Change Font
Change the selected Bear Font.
bear://x-callback-url/change-font
?font=
Available values
Capture
Add a new item to a file
beorg://x-callback-url/capture
?title=
The item headline
¬es=
Notes to add to the item
&scheduled=
Schedule the item using a date in the format yyyy-MM-dd
&deadline=
Set the item deadline using a date in the format yyyy-MM-dd
&file=
The name of the file, without an extension, to add the item to
&template=
Name of a template to apply
&edit=
Whether or not the user can edit the item before it is created
View Agenda
Open the app to the agenda view
beorg://x-callback-url/agenda
View A File
Open the provided file for viewing
beorg://x-callback-url/file
?file* =
The name of the file to be opened
shorten
Create a shortened link. The user will be prompted to add the new link to her list of links. If she chooses not to, the link will be returned as a "url" parameter on the x-success callback.
bitly://x-callback-url/shorten
?url* =
the URL to be shortened
&x-success=
URL to be called with the shortened link as a "url" parameter.
Open
Opens Blackbox.
blackbox://
Unlock Meta Challenge
Unlocks a deep link related meta challenge.
blackbox://meta
Reset
Presents options for resetting the game.
blackbox://reset
New
Create a new file in Byword.
byword://x-callback-url/new
?location=
If not specified, defaults to the location being browsed. If there is none, Byword will ask the location. One of the following:
&path=
The directory path. If not specified, defaults to the folder being browsed. If there is none, the root folder of the location is used.
&name=
The filename of the file to create, with extension. If a filename already exists a new one is created. If not specified an untitled file is created.
&text=
The text to insert into the new file.
Open
Open an existing file. Fails if the file does not exist.
byword://x-callback-url/open
?location=
If not specified, defaults to the location being browsed. If there is none, Byword will ask the location. One of the following:
&path=
The directory path. If not specified, defaults to the folder being browsed. If there is none, the root folder of the location is used.
&name=
The filename of the file to open, with extension.
Append
Append content to an existing file. If the file does not exist a new one is created.
byword://x-callback-url/append
?location=
If not specified, defaults to the location being browsed. If there is none, Byword will ask the location. One of the following:
&path=
The directory path. If not specified, defaults to the folder being browsed. If there is none, the root folder of the location is used.
&name=
The filename of the file to open, with extension. If the file doesn’t exist it will be created.
&text=
The text to append.
Prepend
Prepend content to an existing file. If the file does not exist a new one is created.
byword://x-callback-url/prepend
?location=
If not specified, defaults to the location being browsed. If there is none, Byword will ask the location. One of the following:
&path=
The directory path. If not specified, defaults to the folder being browsed. If there is none, the root folder of the location is used.
&name=
The filename of the file to open, with extension. If the file doesn’t exist it will be created.
&text=
The text to prepend.
Replace
Replace the contents of an existing file. If the file doesn’t exist a new one is created.
byword://x-callback-url/replace
?location=
If not specified, defaults to the location being browsed. If there is none, Byword will ask the location. One of the following:
&path=
The directory path. If not specified, defaults to the folder being browsed. If there is none, the root folder of the location is used.
&name=
The filename of the file. If the file doesn’t exist it will be created.
&text=
The text to insert.
create
Create a new document with the given name and contents. It is saved in the active storage location in the folder that was last browsed. The document is opened and set to edit.
calca://x-callback-url/create
?body* =
Can contain full Markdown text and calculations.
&title* =
Will become the file name and should not have a file extension attached.
calc
Calc a block of text and return it to the calling application. The text is computed in the same way as if it were opened in Calca: all lines with => are computed and the values written out.
calc://x-callback-url/calc
?body* =
Can range from a simple query suchas as 2+2=> to a full document.
&x-success* =
A URL to open after the text has been calculated. If the URL contains the string [[output]], it is replaced with the fully calculated text.
Open URL
Open the given URL
googlechrome-x-callback://x-callback-url/open
?url* =
The URL to open
New
Creates a new file. If one exists, a file with a unique name will be created.
coda://x-callback-url/new
?name* =
The filename (if not included, creates a unique filename).
&path=
The directory path (if not included, defaults to Documents).
&text=
The text to add to the file.
Append
Append text to a file, creating it if necessary.
coda://x-callback-url/append
?name=
The filename (if not included, creates a unique filename).
&path=
The directory path (if not included, defaults to Documents).
&text=
The text to add to the file.
Replace
Replaces the contents of a file, creating it if necessary.
coda://x-callback-url/replace
?name=
The filename (if not included, creates a unique filename).
&path=
The directory path (if not included, defaults to Documents).
&text=
The text to add to the file.
create new gist
Create a new gist on github.com.
codehub://x-callback-url/gist/create
?description=
A string description of the Gist. Default is empty
&public=
A boolean value indicating whether the gist is public or not. Default is false.
&fileN=
This parameter can be defined multiple times. The "N" in the name is a placeholder for a unique name for the file. The value of the argument is the content of the file
Show Clipboard
Show the clipboard.
copied://clipboard
Open List
Open list with the name ”listName”.
copied://list/{listName}
Find Clipping
Search the content with a query.
copied://search
?q* =
The query to search for.
New Clipping
Add a new clipping to Copied. All parameters are option, if neither ”title” nor ”url” are given the content of the clipboard will be used.
copied://x-callback-url/save
?title=
The title of the clippping.
&text=
The text of the clipping.
&url=
The url of the clipping
&list=
The list to add the clipping to
Copy Clipping
Copy the clipping at the given index.
copied://x-callback-url/copy
?index* =
An integer that starts from 0.
&list=
If a name of a list is given the index will be inside that list
Create entry
dayone://post
?entry* =
Entry content (Markdown)
&tags=
Comma separated list of tags
&journal=
Journal name
&imageClipboard=
Attach image from the clipboard
Edit entry
dayone://edit
?entryId* =
Entry ID to edit (UUID)
Open Day One
dayone://
Open Actifity Feed
dayone://activity
Open Timeline
dayone://entries
Open Calendar
dayone://calendar
Open Starred Entries
dayone://astarred
Open Preferences
dayone://preferences
Clip
Opens the New Document Assistant, pre- filled with the provided data.
x-devonthink://x-callback-url/clip
?destination=
The UUID of a group or database where the item shall be created. If the 'destination' parameter is not specified the item is created in the global inbox.
&title=
The title of the item to be created.
&comment=
A comment to be added to the item.
&location=
The URL linking to the content, e.g., the URL of the website for the bookmark or the image.
&tags=
Comma-separated list of tags to be attached to the created item.
&flagged=
marks or unmarks the item as flagged
&unread=
marks or unmarks item as unread
&label=
Sets the item's label (0-based index or name of the label).
Create Bookmark
Creates a new bookmark.
x-devonthink://x-callback-url/createbookmark
?destination=
The UUID of a group or database where the bookmark shall be created. If the 'destination' parameter is not specified the bookmark is created in the global inbox.
&title=
The title of the bookmark to be created.
&comment=
A comment to be added to the bookmark.
&location=
The URL linking to the content, e.g., the URL of the website for the bookmark or image.
&tags=
Comma-separated list of tags to be attached to the created bookmark.
&flagged=
marks or unmarks the bookmark as flagged
&unread=
marks or unmarks bookmark as unread
&label=
Sets the bookmark's label (0-based index or name of the label).
Create Group
Creates a new group.
x-devonthink://x-callback-url/creategroup
?destination=
The UUID of a group or database where the group shall be created. If the 'destination' parameter is not specified the group is created in the global inbox.
&title=
The title of the group to be created.
&comment=
A comment to be added to the group.
&location=
The URL linking to the content, e.g., the URL of the website for the bookmark or the image.
&tags=
Comma-separated list of tags to be attached to the created group.
&flagged=
marks or unmarks the group as flagged
&unread=
marks or unmarks group as unread
&label=
Sets the group's label (0-based index or name of the label).
Create Text
Creates a new plain text document.
x-devonthink://x-callback-url/createtext
?destination=
The UUID of a group or database where the text shall be created. If the 'destination' parameter is not specified the text is created in the global inbox.
&title=
The title of the text to be created.
&comment=
A comment to be added to the text.
&location=
The URL linking to the content, e.g., the URL of the website for the bookmark or the image.
&tags=
Comma-separated list of tags to be attached to the created text.
&flagged=
marks or unmarks the text as flagged
&unread=
marks or unmarks text as unread
&label=
Sets the text's label (0-based index or name of the label).
Create Markdown
Creates a new Markdown document.
x-devonthink://x-callback-url/createmarkdown
?destination=
The UUID of a group or database where the Markdown document shall be created. If the 'destination' parameter is not specified the Markdown document is created in the global inbox.
&title=
The title of the Markdown document to be created.
&comment=
A comment to be added to the Markdown document.
&location=
The URL linking to the content, e.g., the URL of the website for the bookmark or the image.
&tags=
Comma-separated list of tags to be attached to the created Markdown document.
&flagged=
marks or unmarks the Markdown document as flagged
&unread=
marks or unmarks Markdown document as unread
&label=
Sets the Markdown document's label (0-based index or name of the label).
Create Webarchive
Creates a new webarchive.
x-devonthink://x-callback-url/createwebarchive
?destination=
The UUID of a group or database where the item shall be created. If the 'destination' parameter is not specified the item is created in the global inbox.
&title=
The title of the web archive to be created.
&comment=
A comment to be added to the web archive.
&location=
The URL linking to the content, e.g., the URL of the website for the bookmark or the image.
&tags=
Comma-separated list of tags to be attached to the created web archive.
&flagged=
marks or unmarks the web archive as flagged
&unread=
marks or unmarks web archive as unread
&label=
Sets the web archive's label (0-based index or name of the label).
Import Clipboard
Imports data from the pasteboard to the global inbox.
x-devonthink://x-callback-url/import-clipboard
Create Document
Creates a new document from UTI and file data.
x-devonthink://x-callback-url/document
?uti* =
the uti for the document.
&source* =
Base64-encoded file data.
&destination=
The UUID of a group or database where the document shall be created. If the 'destination' parameter is not specified the document is created in the global inbox.
&title=
The title of the document be created.
&comment=
A comment to be added to the document.
&location=
The URL linking to the content, e.g., the URL of the website for the bookmark or the image.
&tags=
Comma-separated list of tags to be attached to the created document
&flagged=
marks or unmarks the document flagged
&unread=
marks or unmarks document as unread
&label=
Sets the document's label (0-based index or name of the label).
Search
Search DEVONthink To Go and show or retrieve the results.
x-devonthink://x-callback-url/search
?query* =
The query to use for the search.
&scope=
The UUID of the database or group to search. Optional; if not set DEVONthink To Go searches all databases.
Create Html
Creates a new HTML document.
x-devonthink://x-callback-url/createhtml
?source* =
Raw HTML data.
&destination=
The UUID of a group or database where the html document shall be created. If the 'destination' parameter is not specified the html document is created in the global inbox.
&title=
The title of the html document be created.
&comment=
A comment to be added to the html document.
&location=
The URL linking to the content, e.g., the URL of the website for the bookmark or the image.
&tags=
Comma-separated list of tags to be attached to the created html document
&flagged=
marks or unmarks the html document flagged
&unread=
marks or unmarks html document as unread
&label=
Sets the html document's label (0-based index or name of the label).
Create Image
Creates a new image.
x-devonthink://x-callback-url/createimage
?source* =
Base64-encoded image file data.
&destination=
The UUID of a group or database where the image shall be created. If the 'destination' parameter is not specified the image is created in the global inbox.
&title=
The title of the image created.
&comment=
A comment to be added to the image
&location=
The URL linking to the content, e.g., the URL of the website for the bookmark or the image.
&tags=
Comma-separated list of tags to be attached to the created image
&flagged=
marks or unmarks the image flagged
&unread=
marks or unmarks image as unread
&label=
Sets the image's label (0-based index or name of the label).
Update Item
Updates an existing item.
x-devonthink://x-callback-url/update
?uuid* =
The UUID of the item, e.g., derived from an item link
&source=
Base64-encoded file data to be set as the item's new content. The source and text parameters are mutually exclusive with source taking precedence if both are present.
&destination=
The UUID of a group or database where the item shall be moved to. You can only provide one destination; if the item was previously replicated to more than one group it will be unlinked from all of them and placed into the new group.
&text=
Text content to be set for the document. The source and text parameters are mutually exclusive with source taking precedence if both are present.
&title=
A new title for the item.
&comment=
A comment to be set in the item's metadata.
&location=
A URL to be set in the item's metadata.
&tags=
Comma-separated list of tags to be added to the item. If the item was already tagged the previous tags are removed and the new set of tags is added.
&flagged=
marks or unmarks the item flagged
&unread=
marks or unmarks item as unread
&label=
Sets the item's label (0-based index or name of the label).
Retrieve Document Metadata
Returns selected metadata of a document as JSON object.
x-devonthink://x-callback-url/item
?uuid* =
The UUID of the document, e.g., derived from an item link
Retrieve Document Data
Returns selected metadata of a document as JSON object.
x-devonthink://x-callback-url/content
?uuid* =
The UUID of the document, e.g., derived from an item link
Retrieve Group Contents
Returns a JSON array describing the contents of a group.
x-devonthink://x-callback-url/list
?uuid* =
The UUID of the group, smart group, or database, e.g., derived from an item link
Get Selected Item's Link
Returns the item link for the currently selected document.
x-devonthink://x-callback-url/get-itemlink
Translate
Translate a phrase in dict.cc.
dictcc-x-callback://x-callback-url/translate
?word=
The word or sentence to translate.
&language-pair=
For example ”de-en” to translate from German to English.
&x-success=
The string ”DCCTRANS” in your x-success URL will be replaced with the translation.
Create
Create a new draft with the content passed in the “text” argument.
drafts5://x-callback-url/create
?text* =
Text to be used at the content of the new draft.
&tag=
Name of a tag to attach to the draft. Parameter can appear multiple times to add more than one tag.
&action=
Name of an action in the action list. If provided, this action will be run on the specified draft.
&allowEmpty=
If an action parameter is provided, adding allowEmpty=false to the URL will prevent that action from running if the text is empty. This can be used to terminate a loop of x-callback-urls running on lines of a draft.
Open
Open an existing draft based on the UUID argument.
drafts5://x-callback-url/open
?uuid* =
The UUID identifier for a draft.
&action=
Name of an action in the action list. If provided, this action will be run on the specified draft.
&allowEmpty=
If an action parameter is provided, adding allowEmpty=false to the URL will prevent that action from running if the text is empty. This can be used to terminate a loop of x-callback-urls running on lines of a draft.
Get
Return the current content of the draft specified by the UUID argument as an argument to the x-success URL provided.
drafts5://x-callback-url/get
?uuid* =
The UUID identifier for a draft.
&retParam=
The name of the argument to use to pass the draft content back to the x-success URL. Defaults to “text”, but if the requesting app expects another value (like Workflow’s “input”) use this argument to override.
Prepend
Prepend the passed text to the beginning of a draft identified by the UUID argument.
drafts5://x-callback-url/prepend
?uuid* =
The UUID identifier for a draft.
&text* =
Text to add.
&action=
Name of an action in the action list. If provided, this action will be run on the specified draft.
&allowEmpty=
If an action parameter is provided, adding allowEmpty=false to the URL will prevent that action from running if the text is empty. This can be used to terminate a loop of x-callback-urls running on lines of a draft.
&tag=
Name of a tag to attach to the draft. Parameter can appear multiple times to add more than one tag.
Append
Append the passed text to the end of a draft identified by the UUID argument.
drafts5://x-callback-url/prepend
?uuid* =
The UUID identifier for a draft.
&text* =
Text to add.
&action=
Name of an action in the action list. If provided, this action will be run on the specified draft.
&allowEmpty=
If an action parameter is provided, adding allowEmpty=false to the URL will prevent that action from running if the text is empty. This can be used to terminate a loop of x-callback-urls running on lines of a draft.
&tag=
Name of a tag to attach to the draft. Parameter can appear multiple times to add more than one tag.
Repace Range
Replace content in an existing draft, based on a range.
drafts5://x-callback-url/replaceRange
?uuid* =
The UUID identifier for a draft.
&text* =
Text to insert in the specified range
&start* =
Start position of the range to replace.
&length* =
Number of characters in the range to replace.
Search
Open drafts directly to the draft search field.
drafts5://x-callback-url/search
?query=
Initial text to use in the search.
&tag=
Tag to use to filter the query.
Workspace
Open drafts directly the draft list with a named workspace selected.
drafts5://x-callback-url/workspace
?name=
Name of a saved workspace to load.
Run Action
Run a drafts action on the passed text without saving that text to a draft.
drafts5://x-callback-url/runAction
?text* =
Text to add
&action=
Name of an action in the action list. If provided, this action will be run on the specified draft.
&allowEmpty=
If an action parameter is provided, adding allowEmpty=false to the URL will prevent that action from running if the text is empty. This can be used to terminate a loop of x-callback-urls running on lines of a draft.
Dictate
Open Drafts dictation interface. Pass the resulting dictated text to the x-success URL instead of saving it in Drafts.
drafts5://x-callback-url/dictate
?locale=
Locale identifier to use for dictation, in the standard language-country abbreviated format. Examples: en-US (English-United States), it-IT (Italian-Italy), es-MX (Spanish-Mexico), etc. Any locale supported by Siri dictation can be used.
&retParam=
The name of the argument to use to pass the draft content back to the x-success URL. Defaults to “text”, but if the requesting app expects another value (like Workflow’s “input”) use this argument to override.
Arrange
Open Drafts arrange interface. Pass the resulting arranged text to the x-success URL instead of saving it in Drafts.
drafts5://x-callback-url/arrange
?text* =
Text to arrange.
&retParam=
The name of the argument to use to pass the draft content back to the x-success URL. Defaults to “text”, but if the requesting app expects another value (like Workflow’s “input”) use this argument to override.
Add
Launches Due on the iOS device with the add reminder view prefilled using information provided in the parameters described below.
due://x-callback-url/add
?title=
The title for the reminder. If provided, the title of the reminder is filled up automatically and the keyboard will not be shown automatically.
&duedate=
The due date of the new reminder, expressed in number of seconds from the first instant of 1 January 1970, GMT. Use to set an absolute due date for the reminder. The ”duedate” is interpreted according to the optional ”timezone” value.
&secslater=
The due date of the new reminder, expressed in number of seconds from now. Use to set a relative due date for the reminder from now. Due would calculate a due date for the reminder based on this value. If ”duedate” is filled, Due would ignore the ”secslater”, ”minslater” and ”hourslater” parameters and set up the reminder’s due date based on the ”duedate” parameter only.
&minslater=
The due date of the new reminder, expressed in number of minutes from now. Use to set a relative due date for the reminder from now. Due would calculate a due date for the reminder based on this value. If ”duedate” is filled, Due would ignore the ”secslater”, ”minslater” and ”hourslater” parameters and set up the reminder’s due date based on the ”duedate” parameter only.
&hourslater=
The due date of the new reminder, expressed in number of hours from now. Use to set a relative due date for the reminder from now. Due would calculate a due date for the reminder based on this value. If ”duedate” is filled, Due would ignore the ”secslater”, ”minslater” and ”hourslater” parameters and set up the reminder’s due date based on the ”duedate” parameter only.
&timezone=
The timezone used to interpret the dates provided in ”duedate” and ”recurfromdate” parameters, expressed as a string for use with ”[NSTimeZone timeZoneWithName:]” method. If unspecified, dates provided in the ”duedate” and ”recurfromdate” parameters are interpreted as absolute GMT times or Universal times.
&recurunit=
The calendar interval (NSCalendarUnit) at which to repeat the reminder. Valid values are ”NSDayCalendarUnit” (16), ”NSWeekCalendarUnit” (256), ”NSMonthCalendarUnit” (8) and ”NSYearCalendarUnit” (4).
&recurfreq=
The frequency at which the recurrence rule repeats over the unit of time indicated in ”recurunit”. For example, a reminder with recurunit of NSWeekCalendarUnit (256) and recurfreq of 2 will repeat every 2 weeks. Valid values are 1-30. The default value is 1, ie. repeat every 1 of recurunit.
&recurfromdate=
The date to start recurrence from (eg. every 3 days from this date), expressed in number of seconds from the first instant of 1 January 1970, GMT. Usually the same as the ”duedate”. If unspecified, the recurrence will be repeat-from-completion, eg. a yearly repeat-on-completion reminder will repeat again on June 1st, 2012 if the user completes it on June 1st, 2011, but will repeat on June 3rd, 2012 if the user only completes it on June 3rd, 2011.
&recurbyday=
A comma-separated list of days of the week. The day-of-week units corresponds to the integers 1 through 7 (where 1 is Sunday, 2 is Monday, 7 is Saturday) for weekly repeating reminders, but must be modified to the integers 8 through 42 to indicate the nth occurrence of the specific day-of-week within a monthly repeating reminder. The values 1 through 7 indicate all days of this type within the recurunit, and is only valid for use with weekly reminders. Monthly recurunit reminders require you to specify the nth occurrence of the day-of-week within the month. To indicate the nth occurrence, you need to add n*7 to the day-of-week unit (where n=1 through 4 indicates 1st through 4th occurences, and n=5 indicates the last occurrence within the month).
&recurbysetpos=
A single integer of value 1 or -1 that is used only in conjunction with a monthly ”recurunit” along with a valid ”recurbydays” to indicate either the nth occurrence of a day or weekday of the month. The first day of the month can be indicated with a recurbysetpos of value 1, with a recurbydays of values 1,2,3,4,5,6,7.
Search
Launches Due on the iOS device and searches for a query string in the specified section.
due://x-callback-url/search
?query=
The string to search for when Due is launched.
§ion=
The section to search in. Can either be 'Reminders', 'Timers' or 'Logbook'. If not provided, or if an invalid value is provided, the search will take place in Reminders.
Parse
Begin creating a new event with the given sentence.
fantastical2://x-callback-url/parse
?sentence=
Begin creating a new event with the given sentence.
¬es=
The notes parameter can be added to specify a note with the event.
&add=
Set to 1 to automatically add an event - be careful!
&reminder=
Set to 1 to make this a reminder instead of an event.
&due=
When is the reminder due. Requires the format ”yyyy-MM-dd HH:mm”
&title=
The event title
&location=
The event location
&url=
A URL for the event
&start=
The start time of the event. Requires the format ”yyyy-MM-dd HH:mm”
&end=
The end time of the event. Requires the format ”yyyy-MM-dd HH:mm”
&allDay=
Set to 1 to make this an all day event
Show
Jumps to the specified date.
fantastical2://x-callback-url/show
?date=
The date to jump to. Supports the following formats
Open Forward SMS
To launch Forward SMS.
forwardsms://
View Integrations
To view available integrations.
forwardsms://integrations
Open Forward SMS Settings
To open Forward SMS settings.
forwardsms://settings
View Undelivered Messages
To view messages that failed to deliver.
forwardsms://undeliveredMessages
View Setup Instructions
To view the setup instructions.
forwardsms://setupInstructions
View Empty Message Resolution
To view help for empty message issues.
forwardsms://emptyMessageResolution
Open Genshin
To launch Genshin.
yuanshengame://
Paste Clipboard
Paste clipboard into Gladys
gladys://x-callback-url/paste-clipboard
?title=
A title to use to override the name of the item being pasted.
&labels=
A comma-separated list of labels that will be added to the item that is being pasted.
¬e=
Text to add as a note for the item being pasted.
Compose
Compose a mail.
googlegmail-x-callback://x-callback-url
?subject=
The mail’s subject.
&body=
The mail’s body text.
&to=
The recipient.
&cc=
The ”cc” recipient.
&bcc=
The ”bcc” recipient.
Display a map
Display the map at a specified zoom level and location. You can also overlay other views on top of your map, or display Street View imagery.
comgooglemaps-x-callback://x-callback-url
?center=
This is the map viewport center point. Formatted as a comma separated string of ”latitude,longitude”
&mapmode=
Sets the kind of map shown. Can be set to: ”standard” or ”streetview”. If not specified, the current application settings will be used.
&views=
Turns specific views on/off. Can be set to: ”satellite”, ”traffic”, or ”transit”. Multiple values can be set using a comma-separator. If the parameter is specified with no value, then it will clear all views.
&zoom=
Specifies the zoom level of the map.
Search
Display search queries in a specified viewport location.
comgooglemaps-x-callback://x-callback-url
?q=
The query string for your search.
¢er=
This is the map viewport center point. Formatted as a comma separated string of ”latitude,longitude”
&mapmode=
Sets the kind of map shown. Can be set to: ”standard” or ”streetview”. If not specified, the current application settings will be used.
&views=
Turns specific views on/off. Can be set to: ”satellite”, ”traffic”, or ”transit”. Multiple values can be set using a comma-separator. If the parameter is specified with no value, then it will clear all views.
&zoom=
Specifies the zoom level of the map.
Directions
Request and display directions between two locations.
comgooglemaps-x-callback://x-callback-url
?saddr=
Sets the starting point for directions searches. This can be a ”latitude,longitude” or a query formatted address. If it is a query string that returns more than one result, the first result will be selected. If the value is left blank, then the user’s current location will be used.
&daddr=
Sets the end point for directions searches. Has the same format and behavior as ”saddr”
&directionsmode=
Method of transportation. Can be set to.
Add Bookmark
Adds a bookmark with the given URL and title to the Bookmarks of iCab Mobile
x-icabmobile://x-callback-url/addBookmark
?url* =
The URL to add as bookmark.
&title=
The title of the bookmark.
Add Filter
Creates a new filter. Without the type parameter, iCab defaults to “block”
x-icabmobile://x-callback-url/addFilter
?url* =
Filter URL. Can use wildcards “*”, “?” and “[abc]” to make the url filter valid for more than a single page.
&type=
Add Search Engine
Adds a new search engine to the list of search engines.
x-icabmobile://x-callback-url/addSearchEngine
?url* =
Should include the string “%@” where the search term needs to be added
&title=
The name of the search engine
Add Reading List
Adds the page with the given URL and title to the Reading list
x-icabmobile://x-callback-url/addReadingList
?url* =
The URL to add.
&title=
The title in the reading list.
Search
Launches iCab and opens the search window, so the user can directly start entering a search term, if the search term is given, the search is started immediately.
x-icabmobile://x-callback-url/search
?searchTerm=
The term to search for
Fullscreen
Launches iCab in fullscreen mode.
x-icabmobile://x-callback-url/fullscreen
Normal Mode
Launches iCab in normal mode.
x-icabmobile://x-callback-url/normalmode
Open
Opens the page in the given destination and enters the fullscreen mode when requested. The URL “quickstarter:” can be used to open the Quickstarter page.
x-icabmobile://x-callback-url/open
?url* =
The URL to open.
&destination=
Where to open the URL. One of the following:
&fullscreen=
Download
Starts the download of the file at URL and uses the filename to save it in the download manager.
x-icabmobile://x-callback-url/download
?url* =
The URL to download from.
&filename=
Filename to save it in downloadmanager.
&referrer=
The referrer can be set, in case a web page only allows the download if it was initiated from a certain web page.
Open IFTTT
To launch IFTTT.
ifttt://
Open Infuse
Opens Infuse.
infuse://
Play Video in Infuse
Plays the video from the provided URL in Infuse.
infuse://x-callback-url/play
?url* =
URL encoded URL of a video to be played in Infuse
&x-success=
A URL that opens once the video has been played.
&x-error=
A URL that opens if the playback of the video failed.
Add URL
Add the URL to Instapaper.
x-callback-instapaper://x-callback-url/add
?url=
The URL to add.
Open Launcher
Open launcher app.
launcher://
?idx=
0-based index of widget page to open. Defaults to 0 which is the first Launcher widget.
Add New Launcher
Add a new launcher.
launcher://x-callback-url/addnew
?name* =
The name for the new launcher.
&url* =
The URL to launch for the new launcher.
&iconB64=
Base64-encoded icon for the new launcher. Should be at least 152x152 pixels. If not included, will try to use current image on clipboard.
&idx=
0-based index of widget to add launcher to. Defaults to 0 which is the first launcher widget.
Open Lovense Remote
To launch Lovense Remote.
wear://
Start Timer
multitimer://x-callback-url/start-timer
?name* =
Timer label.
&board=
Board title.
Stop timer
multitimer://x-callback-url/stop-timer
?name* =
Timer label.
&board=
Board title.
Pause timer
multitimer://x-callback-url/pause-timer
?name* =
Timer label.
&board=
Board title.
Resume timer
multitimer://x-callback-url/resume-timer
?name* =
Timer label.
&board=
Board title.
Run command
multitimer://x-callback-url/run-command
?name* =
Command name.
Open myQ
To launch myQ.
myliftmaster://
Show note
A direct link to a note. To get the identifier see the documentation url above.
mobilenotes://showNote
?identifier* =
The identifier of the note
Add
Add a task to OmniFocus
omnifocus://x-callback-url/add
?name* =
The name of the action
¬e=
An optional note
&attachment=
A base 64 encoded attachment file
&attachment-name=
The name of the attachment
¶llel=
&flag=
&defer=
date and time, like 'jun 25 8am'
&due=
date and time, like 'jun 25 8am'
&project=
case-insensitive match
&context=
case-insensitive match
&autocomplete=
Do children mark project complete?
&estimate=
30m for 30 minutes
&reveal-new-items=
&repeat-method=
&completed=
date and time, like 'jun 25 8am'
Inbox perspective
omnifocus:///inbox
Flagged perspective
omnifocus:///flagged
Project perspective
omnifocus:///projects
Contexts perspective
omnifocus:///contexts
Past forecast
omnifocus:///past
Today forecast
omnifocus:///today
Soon forecast
omnifocus:///soon
Create
Create a new document.
onewriter://x-callback-url/create
?path=
The path to the folder in which you want to create the document.
&name=
The name for the document.
&text=
The content for the document. If not specified, the content of the clipboard will be used.
Replace
Replace content of a document.
onewriter://x-callback-url/replace
?path=
The path to the document.
&text=
The content for the document. If not specified, the content of the clipboard will be used.
Replace Selection
Replace selected text in the current editing document.
onewriter://x-callback-url/replace-selected
?text=
The replacement text.
Content
Return content of a document.
onewriter://x-callback-url/content
?path=
The path to the document.
¶m=
The content will be passed to the x-success URL using this parameter name. Default value is ”text”.
Create Todo
Create a to-do list by separating lines of the text parameter. You can start a line with ”+” to indicate a completed todo.
onewriter://x-callback-url/create-todo
?path=
The path to the folder in which you want to create the document.
&name=
The name for the document.
&text=
The content for the document. If not specified, the content of the clipboard will be used.
Open document
Create a new document.
onewriter://x-callback-url/open
?path=
The path to the document.
Append
Append to an existing document.
onewriter://x-callback-url/append
?path=
The path to the document.
&text=
The content for the document. If not specified, the content of the clipboard will be used.
Prepend
Prepend content to an existing document.
onewriter://x-callback-url/prepend
?path=
The path to the document.
&text=
The content for the document. If not specified, the content of the clipboard will be used.
Show options
Show the available options to open a given URL.
opener://x-callback-url/show-options
?url* =
The URL
&allow-auto-open=
Set to ”false” to make the app not perform any automatic actions on launch.
Show Store Product Details
Shows the details of an iTunes product within Opener (or Opener's action extension if open) in an ”SKStoreProductViewController” or an iOS store app.
opener://x-callback-url/show-store-product-details
?id* =
A numeric iTunes identifier for the product.
Open
Open an outline.
outlinely://x-callback-url/open
?path* =
The path to the outline. Example: ”Inbox/Today”, ”Ideas/Business Idea”. Case sensitive.
&storage=
New
Create a new outline.
outlinely://x-callback-url/new
?text* =
Initial content
&group* =
The path to the group where the new outline is created. Example: ”Inbox”, ”Idea”, ”Research/Technology”.
&title=
The outline’s title
&storage=
&type=
insert
Insert text into an existing outline.
outlinely://x-callback-url/insert
?text* =
Initial content
&path* =
The path to the outline. Example: ”Inbox/Today”, ”Ideas/Business Idea”. Case sensitive.
&storage=
&parent=
If specified, Outlinely will attempt to add text to section in the outline with the specified name.
&mode=
Add Url
Subscribe to a new show under the given URL
overcast://x-callback-url/add
?url=
It will parse the URL and find the associated podcast feed.
Show Explore
Open the Explore tab.
pricetag://explore
Show Favorite List
Open the Favorite tab.
pricetag://favorites
Show Price Drop List
Open the Price Drop tab.
pricetag://pricedrop
Show App Detail Using URL
Show the app detail using the App Store URL of the App.
pricetag://app
?url* =
App Store URL
Show App Detail Using ID
Show the app detail using the App Store ID of the App.
pricetag://app
?id* =
App Store ID
Import Apps
Import apps into Price Tag.
pricetag://import
?ids* =
Commas separated list of App Store ID's
Search
Searches Price Tag.
pricetag://search
?key* =
URL encoded search parameters.
&p=
Type of search being performed. Defaults to iOS if not specified.
Capture Text
Start Prizmo to take a picture and perform English OCR on it. The following options are supported:
prizmo://x-callback-url/captureText
?language=
language can be any ISO 639-1 language code (like en, fr, de) and will instruct which language should be picked in the OCR engine.
&destination=
Destination can be either 'url' to send the captured text in the callback URL to the calling app, or 'pasteboard' to write the text in a pasteboard.
&pasteboardName=
when destination is set to 'pasteboard', this option can be used to determine which pasteboard should be used (the default value is the general pasteboard).
&cropMode=
This controls the cropping method used while taking the picture in Prizmo. Possible values are:
&x-success=
The resulting text is passed as the ”text” argument if destination is set to ”url” (see above).
Read Text
Will read the provided text with the Ryan voice in Prizmo Voice Reader.
prizmo://x-callback-url/readText
?text* =
The text to read in Prizmo Voice Reader.
&voice=
The voice that should be used to read the text. The voice should have been previously installed by the user.
&language=
if a specific voice is not set, the language can be specified. It will pick the first available voice for that language.
Running code
Run the passed Python code.
pyto://x-callback
?code* =
Python code to execute.
Run
runjavascript://x-callback-url/run
?script=
URL encoded JavaScript to run. Either script or file parameter is required
&file=
Used to execute JavaScript files stored in the local documents folder or at a remote location. Files ending with .js will be handled as script file. Files ending with .html will be rendered as web page and RunJavaScript API will be injected. Any http resource will be rendered as web page and RunJavaScript API will be injected. Either script or file parameter is required
&baseURL=
value will be set as the origin of execution environment. It is useful while making REST calls to remote servers.
&input=
Input data to be used by the script. Input can be text (URL encoded), JSON (URL encoded) or other format.
&inputName=
Parameter name used as input. If provided input data will be retrieved from parameter named by inputName.
Open Scriptable
Opens Scriptable.
scriptable://
Add Script
Add a new script.
scriptable:///add
Open Script
Add a new script.
scriptable:///open
?scriptName* =
URL Encoded name of the script to be opened.
&openSettings=
Indicates if the script settings should be opened.
Run Script
Run a script.
scriptable:///run
?scriptName* =
URL Encoded name of the script to be run.
Show All Lists
Ensure the main display is showing the view showing all shopping lists.
shopi://x-callback-url/show-lists
Show List
Show a specific list.
shopi://x-callback-url/show-list
?name* =
The list name.
Create List
Create a new list
shopi://x-callback-url/create-list
?name* =
The list name.
Add List Item
Add an item to a list (or the currently displayed list if not specified).
shopi://x-callback-url/add-item
?list* =
The name of the list to add this item to.
&name* =
The name of the item to add.
&amount=
How many.
&crossed=
Should the item be crossed (”yes”) or not (”no”)
Clear List Items
Clear items from a list.
shopi://x-callback-url/clear-list
?name* =
The list name.
&crossed-only=
Only clear crossed items when set to “yes”.
Open Shortcuts
Launch the app to the state when it was last used.
shortcuts://
Create a New Shortcut
Jump to the shortcut editor and to create a new, empty shortcut.
shortcuts://create-shortcut
Open a Shortcut
Launch the app to a particular shortcut in your collection.
shortcuts://open-shortcut
?name* =
The name of the shortcut
Run a Shortcut
This functionality may be useful in automation systems that extend beyond Shortcuts itself, so that other apps can run a shortcut in your collection. Or you could use the Shortcuts URL scheme in a task manager like OmniFocus or Todoist for running a shortcut as one step in a project.
shortcuts://x-callback-url/run-shortcut
?name* =
The name of the shortcut to run
&input=
This value determines what will be provided as input to the beginning of the shortcut.
&text=
When the ”input” parameter is set to ”text” this text is used as input to the shortcut.
&x-success=
A URL that opens when the run was successful. A parameter named result is appended to the URL and contains the textual output of the shortcut.
&x-cancel=
A URL that opens when the run is canceled by the user. Because the shortcut did not complete, no output from the shortcut is provided.
&x-error=
A URL that opens when the run fails because an error occurred. A parameter named errorMessage is appended to the URL and contains a description of the error.
Import a Shortcut
You can import .shortcut files into the Shortcuts app and add them to your collection. This is useful, for example, if you want to share a shortcut online and provide a link for others to quickly add it to their library.
shortcuts://x-callback-url/import-shortcut
?url* =
A URL pointing to the .shortcut file you want to import.
&name=
A title for the new shortcut. If you don’t provide a name, the shortcut filename is used.
&silent=
By default, the imported shortcut is opened and displayed to the user. Set this parameter to ”true” to import without opening the shortcut.
&x-success=
A URL that opens when the import was successful. A parameter named result is appended to the URL and contains the textual output of the shortcut.
&x-cancel=
A URL that opens when the import is canceled by the user.
&x-error=
A URL that opens when the import fails because an error occurred. A parameter named errorMessage is appended to the URL and contains a description of the error.
Open Gallery
Open Shortcuts on the main page of the Gallery.
shortcuts://gallery
Search Gallery
Search the gallery
shortcuts://gallery/search
?query* =
URL-encoded keywords to be searched in the Gallery.
compose
Open a new email draft in Spark
readdle-spark://compose
?subject=
Enter the subject line for the new email message
&body=
Enter the body text for the new email message
&recipient=
Enter the email addresses—separated by commas—for the To field of the new email message
add
Add a new project.
storyplanner://x-callback-url/add
?title* =
the title of the project
project (by title)
Open an existing project by title.
storyplanner://x-callback-url/project
?title* =
the title of the project
&tab=
a tab to open within the project
project (by identifier)
Open an existing project by identifier. You can get the identifier within the project by opening export options and choosing "Copy identifier".
storyplanner://x-callback-url/project
?id* =
the identifier of the project
&tab=
a tab to open within the project
open
tally2://x-callback-url/open
?title* =
name of an existing tally
get
Lookup the tally based on the title parameter, and call the x-success parameter URL with the current value of the tally added as a parameter.
tally2://x-callback-url/get
?title* =
the name of an existing tally
&retParam=
the name of the "value" parameter appended to the x-success callback
&x-success=
The following parameters will be added:
&x-error=
fired if Tally is unable to locate the requested tally
increment
Lookup the tally based on the title parameter, and increment it. Increment will be based on the configuration of the tally – so if it is set to step by 5, the increment will be by five.
tally2://x-callback-url/increment
?title* =
the name of an existing tally
&retParam=
the name of the "value" parameter appended to the x-success callback
&x-success=
The following parameters will be added:
&x-error=
fired if Tally is unable to locate the requested tally
decrement
Lookup the tally based on the title parameter, and decrement it. Decrement will be based on the configuration of the tally – so if it is set to step by 5, the decrement will be by five.
tally2://x-callback-url/decrement
?title* =
the name of an existing tally
&retParam=
the name of the "value" parameter appended to the x-success callback
&x-success=
The following parameters will be added:
&x-error=
fired if Tally is unable to locate the requested tally
reset
Lookup the tally based on the title parameter, and reset it to it's initial value.
tally2://x-callback-url/reset
?title* =
the name of an existing tally
&retParam=
the name of the "value" parameter appended to the x-success callback
&x-success=
The following parameters will be added:
&x-error=
fired if Tally is unable to locate the requested tally
lookup
Launch Terminology and lookup the text, just as if the user had searched for and selected the text from inside Terminology.
terminology://x-callback-url/lookup
?text* =
The text to lookup. Can be a single word, or a text selection.
&action=
The name of a valid action in either the top or bottom actions list in Terminology. If present, the lookup will open directly to the action as if the action were triggered on the lookup term.
&x-source=
A friendly name for the app making the call. It will be displayed to the user to identify the request.
&x-success=
The URL to use to return the user to the calling application. If provided, the user will get a dialog to allow them to easily return to the calling app after viewing the definition.
search
Launches Terminology directly to search for the value of the text parameter.
terminology://x-callback-url/search
?text* =
The text to lookup. Can be a single word, or a text selection.
New File
Create a new file in the local file system or in iCloud. If neither the text parameter nor the snippet parameter is specified, the text to append will come from the clipboard.
textastic://x-callback-url/new
?location=
&path=
The directory path. If not specified, defaults to the root folder.
&name=
The name of the file to create. If a file with that name already exists, Textastic will append a number to the file name to make it unique. If not specified, a file name will be generated by Textastic.
&text=
The text to insert into the new file.
&snippet=
The snippet to insert. If both the ”snippet” and the ”text” parameter are present, only the ”snippet” parameter will be used.
Open File
Open an existing file in the local file system or in iCloud. If the file doesn’t exist, calls the url from the x-error parameter.
textastic://x-callback-url/open
?location=
&path=
The directory path. If not specified, defaults to the root folder.
&name=
The name of the file to open.
Append
Open an existing file or create a new file and append text. If neither the text parameter nor the snippet parameter is specified, the text to append will come from the clipboard.
textastic://x-callback-url/append
?location=
&path=
The directory path. If not specified, defaults to the root folder.
&name=
The name of the file to open. If the file doesn’t exist, it will be created.
&text=
The text to append to the file.
&snippet=
The snippet to append to the file. If both the ”snippet” and the ”text” parameter are present, only the ”snippet” parameter will be used.
Replace
Open an existing file or create a new file and replace its contents with the specified text. If neither the text parameter nor the snippet parameter is specified, the text to append will come from the clipboard.
textastic://x-callback-url/replace
?location=
&path=
The directory path. If not specified, defaults to the root folder.
&name=
The name of the file to open. If the file doesn’t exist, it will be created.
&text=
The text to insert into the file after its contents are deleted.
&snippet=
The snippet to insert into the file after its contents are deleted. If both the ”snippet” and the ”text” parameter are present, only the ”snippet” parameter will be used.
Create
Creates a new document.
textkraftpocket://x-callback-url/create
?text=
The initial text for the new document.
append
Appends text to the current (frontmost) document, if this is an editable text document.
textkraftpocket://x-callback-url/append
?text=
The text to append.
Add
Add a to-do.
things://add
?title=
String. The title of the to-do to add. Ignored if titles is also specified.
&titles=
String separated by new lines (encoded to ”%0a”). Use instead of ”title” to create multiple to-dos. Takes priority over ”title” and ”show-quick-entry”. The other parameters are applied to all the created to-dos.
¬es=
String. The text to use for the notes field of the to-do. Maximum unencoded length: 10,000 characters.
&when=
String. Using a date time string adds a reminder for that time. The time component is ignored if anytime or someday is specified. Possible values:
&deadline=
The deadline to apply to the to-do.
&tags=
Comma separated strings corresponding to the titles of tags. Does not apply a tag if the specified tag doesn’t exist.
&checklist-items=
String separated by new lines (encoded to ”%0a”). Checklist items to add to the to-do (maximum of 100).
&list-id=
String. The ID of a project or area to add to. Takes precedence over ”list”.
&list=
String. The title of a project or area to add to. Ignored if list-id is present.
&heading=
String. The title of a heading within a project to add to. Ignored if a project is not specified, or if the heading doesn't exist.
&completed=
Boolean. Whether or not the to-do should be set to complete. Default: ”false”. Ignored if ”canceled” is also set to ”true”.
&canceled=
Boolean. Whether or not the to-do should be set to canceled. Default: ”false”. Takes priority over “completed”.
&show-quick-entry=
Boolean. Whether or not to show the quick entry dialog (populated with the provided data) instead of adding a new to-do. Ignored if ”titles” is specified. Default: ”false”.
&reveal=
Boolean. Whether or not to navigate to and show the newly created to-do. If multiple to-dos have been created, the first one will be shown. Ignored if ”show-quick-entry” is also set to ”true”. Default: ”false”.
&creation-date=
ISO8601 date time string. The date to set as the creation date for the to-do in the database. Ignored if the date is in the future.
&completion-date=
ISO8601 date time string. The date to set as the completion date for the to-do in the database. Ignored if the to-do is not completed or canceled, or if the date is in the future.
&x-success=
The x-success callback will be called with the follwoing parameter:
Add Project
Add a project.
things://add-project
?title=
String. The title of the project.
¬es=
String. The text to use for the notes field of the project. Maximum unencoded length: 10,000 characters.
&when=
String. Using a date time string adds a reminder for that time. The time component is ignored if anytime or someday is specified. Possible values:
&deadline=
The deadline to apply to the to-do.
&tags=
Comma separated strings corresponding to the titles of tags. Does not apply a tag if the specified tag doesn’t exist.
&area-id=
String. The ID of an area to add to. Takes precedence over ”area”.
&area=
String. The title of an area to add to. Ignored if ”area-id” is present.
&to-dos=
String separated by new lines (encoded to ”%0a”). Titles of to-dos to create inside the project.
&completed=
Boolean. Whether or not the project should be set to complete. Default: ”false”. Ignored if ”canceled” is also set to ”true”.
&canceled=
Boolean. Whether or not the project should be set to canceled. Default: ”false”. Takes priority over “completed”.
&reveal=
Boolean. Whether or not to navigate into the newly created project. Default: ”false”.
&creation-date=
ISO8601 date time string. The date to set as the creation date for the project in the database. If the ”to-dos” parameter is also specified, this date is applied to them, too. Ignored if the date is in the future.
&completion-date=
ISO8601 date time string. The date to set as the completion date for the project in the database. If the ”to-dos” parameter is also specified, this date is applied to them, too. Ignored if the to-do is not completed or canceled, or if the date is in the future.
&x-success=
The x-success callback will be called with the follwoing parameter:
Update
Update an existing to-do.
things://update
?auth-token* =
String. The Things URL scheme authorization token.
&id* =
String. The ID of the to-do to update.
&title=
String. The title of the to-do. This will replace the existing title.
¬es=
String. The notes of the to-do. This will replace the existing notes. Maximum unencoded length: 10,000 characters.
&prepend-notes=
String. Text to add before the existing notes of a to-do. Maximum unencoded length: 10,000 characters.
&append-notes=
String. Text to add after the existing notes of a to-do. Maximum unencoded length: 10,000 characters.
&when=
String. Using a date time string adds a reminder for that time. The time component is ignored if anytime or someday is specified. This field cannot be updated on repeating to-dos. Possible values:
&deadline=
The deadline to apply to the to-do.
&tags=
Comma separated strings corresponding to the titles of tags. Replaces all current tags. Does not apply a tag if the specified tag doesn’t exist.
&add-tags=
Comma separated strings corresponding to the titles of tags. Adds the specified tags to a to-do. Does not apply a tag if the specified tag doesn’t exist.
&checklist-items=
”\n” (encoded to ”%0a”) separated strings. Set the checklist items of the to-do (maximum of 100). Will replace all existing checklist items.
&prepend-checklist-items=
”\n” (encoded to ”%0a”) separated strings. Add checklist items to the front of the list of checklist items in the to-do (maximum of 100). Will replace all existing checklist items.
&append-checklist-items=
”\n” (encoded to ”%0a”) separated strings. Add checklist items to the end of the list of checklist items in the to-do (maximum of 100). Will replace all existing checklist items.
&list-id=
String. The ID of a project or area to move the to-do into. Takes precedence over ”list”.
&list=
String. The title of a project or area to move the to-do into. Ignored if list-id is present.
&heading=
String. The title of a heading within a project to move the to-do to. Ignored if the to-do is not in a project with the specified heading. Can be used together with ”list” or ”list-id”.
&completed=
Boolean. Complete a to-do or set a to-do to incomplete. Ignored if ”canceled” is also set to ”true”. Setting ”completed=false” on a canceled to-do will also mark it as incomplete. This field cannot be updated on repeating to-dos.
&canceled=
Boolean. Cancel a to-do or set a to-do to incomplete. Takes priority over ”completed”. Setting ”canceled=false” on a completed to-do will also mark it as incomplete. This field cannot be updated on repeating to-dos.
&reveal=
Boolean. Whether or not to navigate to and show the updated to-do. Default: ”false”.
&duplicate=
Boolean. Set to ”true” to duplicate the to-do before updating it, leaving the original to-do untouched. Repeating to-dos cannot be duplicated. Default: ”false”.
&creation-date=
ISO8601 date time string. Set the creation date for the to-do in the database. Ignored if the date is in the future.
&completion-date=
ISO8601 date time string. Set the completion date for the to-do in the database. Ignored if the to-do is not completed or canceled, or if the date is in the future. This field cannot be updated on repeating to-dos.
&x-success=
The x-success callback will be called with the follwoing parameter:
Update Project
Update an existing project.
things://update-project
?auth-token* =
String. The Things URL scheme authorization token.
&id* =
String. The ID of the project to update.
&title=
String. The title of the project. This will replace the existing title.
¬es=
String. The notes of the project. This will replace the existing notes. Maximum unencoded length: 10,000 characters.
&prepend-notes=
String. Text to add before the existing notes of a project. Maximum unencoded length: 10,000 characters.
&append-notes=
String. Text to add after the existing notes of a project. Maximum unencoded length: 10,000 characters.
&when=
String. Set the when field of a project. Including a time adds a reminder for that time. The time component is ignored if ”someday” is specified. This field cannot be updated on repeating projects. Possible values:
&deadline=
Date string. The deadline to apply to the project. This field cannot be updated on repeating projects.
&tags=
Comma separated strings corresponding to the titles of tags. Replaces all current tags. Does not apply a tag if the specified tag doesn’t exist.
&add-tags=
Comma separated strings corresponding to the titles of tags. Adds the specified tags to a project. Does not apply a tag if the specified tag doesn’t exist.
&area-id=
String. The ID of an area to move the project into. Takes precedence over ”area”.
&area=
String. The title of an area to move the project into. Ignored if ”area-id” is present.
&completed=
Boolean. Complete a project or set a project to incomplete. Ignored if ”canceled” is also set to ”true”. Setting to ”true” will be ignored unless all child to-dos are completed or canceled and all child headings archived. Setting to ”false” on a canceled project will mark it as incomplete. This field cannot be updated on repeating projects.
&canceled=
Boolean. Cancel a project or set a project to incomplete. Takes priority over ”completed”. Setting to ”true” will be ignored unless all child to-dos are completed or canceled and all child headings archived. Setting to ”false” on a completed project will mark it as incomplete. This field cannot be updated on repeating projects.
&reveal=
Boolean. Whether or not to navigate to and show the updated project. Default: ”false”
&duplicate=
Boolean. Set to ”true” to duplicate the project before updating it, leaving the original project untouched. Repeating projects cannot be duplicated. Default: ”false”.
&creation-date=
ISO8601 date time string. Set the creation date for the project in the database. Ignored if the date is in the future.
&completion-date=
ISO8601 date time string. Set the completion date for the project in the database. Ignored if the project is not completed or canceled, or if the date is in the future. This field cannot be updated on repeating to-dos.
&x-success=
The x-success callback will be called with the follwoing parameter:
Show
Navigate to and show an area, project, tag or to-do, or one of the built-in lists, optionally filtering by one or more tags.
things://show
?id=
String. The ID of an area, project, tag or to-do to show; or one of the following built-in list IDs:
&query=
String. The name of an area, project, tag or a built-in list to show. This is equivalent to entering the query text in to the quick find within Things and selecting the first result. Ignored if ”id” is also set. Note: task cannot be shown using the query parameter; use the ”id” parameter or the ”search” command instead.
&filter=
String. Comma separated strings corresponding to the titles of tags that the list should be filtered by.
Search
Invoke and show the search screen.
things://search
?query=
String. The search query.
Version
The version of the Things app and URL scheme.
things://version
?x-success=
The x-success callback will be called with the follwoing parameters:
JSON
Things also has an advanced, JSON-based add command that allows more control over the projects and to-dos imported into Things. This command is intended to be used by app developers or other people familiar with scripting or programming.
things://json
?auth-token=
String. The Things URL scheme authorization token. This is required whenever the provided JSON data contains an ”update” operation.
&data=
JSON string. The JSON should be an array containing ”to-do” and ”project” objects.
&reveal=
Boolean. Whether or not to navigate to and show the newly created to-do or project. If multiple items have been created, the first one will be shown. Default: ”false”.
&x-success=
The x-success callback will be called with the follwoing parameter:
Add Event
timepage://x-callback-url/add_event
?title=
The title of the event
&day=
The date of the event
Open Event
Open Timepage and show a specified event.
timpage://open_event
?event=
The event identifier
Open Event Map
Open Timepage and show a specified event on the map
timpage://open_event_map
?event=
The event identifier
Open Day
Open Timepage and show a specified day.
timepage://open_day
?day=
Day can be specified as either:
Open Week
Open Timepage and show a specified week
timepage://open_week
?week=
The week to open to. Can be one of
Open Month
Open Timepage and show a specified month
timepage://open_month
?month=
The month to open to. Can be one of
Open Weather For A Day
Open Timepage and show weather for a specified day.
timepage://open_weather
?day=
Day can be specified as either:
Open Weather For A Week
Open Timepage and show weather for a specified week.
timepage://open_weather
?week=
The week to open to. Can be one of
Search
Open Timepage and show search results for the specified search terms.
timepage://search
?query=
Search term to search for.
Get Event
Get a specified event and return its details via a specified callback URL.
timepage://x-callback-url/get_event
?event=
The event identifier
&x-success=
Your x-success callback will be called with the following parameters
Open
Opens Todoist.
todoist://
Open Today
Opens the today view.
todoist://today
Open Next 7 Days
Opens the next 7 days view.
todoist://next7days
Open Profile
Opens the profile view.
todoist://profile
Open Inbox
Opens the inbox view.
todoist://inbox
Open Team Inbox
Opens the team inbox view. If the user doesn’t have a business account (access to team inbox), it will show an alert saying that he/she doesn’t have access to the team inbox because he/she doesn’t have a business account and will be redirected automatically to the inbox view.
todoist://teaminbox
Add Task
Opens the add task view to add a new task to Todoist.
todoist://addtask
?content=
The content of the task, which should be a string that in Percent-encoding (also known as URL encoding).
&date=
The due date of the task, which should be a string that in Percent-encoding (also known as URL encoding). Look at our reference to see which formats are supported.
&priority=
The priority of the task (a number between 1 and 4, 4 for very urgent and 1 for natural). Note: Keep in mind that very urgent is the priority 1 on clients. So, p1 will return 4 in the API.
Projects
Opens the projects view (shows all projects).
todoist://projects
Open Project
Opens a specific project using the id of the project.
todoist://project
?id* =
The id of the project to view. If the id doesn’t exist, you don’t have access to the project, or the value is empty, an alert will be showed and the user will be redirected to the projects view.
Labels
Opens the labels view (shows all labels).
todoist://labels
Open Label
Opens a specific label using the id of the label.
todoist://label
?id* =
The id of the label to view. If the id doesn’t exist, you don’t have access to the label, or the value is empty, an alert will be showed and the user will be redirected to the labels view.
Filters
Opens the filters view (shows all filters).
todoist://filters
Open Filter
Opens a specific filter using the id of the filter.
todoist://filter
?id* =
The id of the filter to view. If the id doesn’t exist, you don’t have access to the filter, or the value is empty, an alert will be showed and the user will be redirected to the filters view.
Search
Used to search in the Todoist application.
todoist://search
?query* =
The query to search in the Todoist application, which should be a string that is in Percent-encoding (also known as URL encoding).
Show Board
Links to a board.
trello://x-callback-url/showBoard
?id=
board id. Use this or the ”shortlink”
&shortlink=
board shortlink. (can be with or without the ”https://trello.com/b/” prefix). Use this or the ”id”
Show Cards
Links to a card.
trello://x-callback-url/showCard
?id=
card id. Use this or the ”shortlink”
&shortlink=
card shortlink. (can be with or without the ”https://trello.com/c/” prefix). Use this or the ”id”
Create Board
Creates a new board.
trello://x-callback-url/createBoard
?name=
Name for the board.
&organization=
Name of the organization in which to create the board.
&permission=
Permission level to set
&x-success=
The callback will be called with the following parameters:
Create Card
Creates a new card in a specified board.
trello://x-callback-url/createCard
?id=
bord id. Use this or the ”shortlink”
&shortlink=
bord shortlink. (can be with or without the ”https://trello.com/b/” prefix). Use this or the ”id”
&name=
The name of the new card.
&description=
The description text to attach to the card.
&list-id=
id of the list within the specified board in which to insert the card (Default: First list)
&use-pasteboard=
Interpreted as a boolean (”0”, ”1”, ”true”, ”false”, etc.) that indicates whether the contents of the pasteboard should be included.
&x-success=
The callback will be called with the following parameters:
Show ”All” Focus List
twodo://x-callback-url/showAll
Show ”Today” Focus List
twodo://x-callback-url/showToday
Show ”Starred” Focus List
twodo://x-callback-url/showStarred
Show ”Scheduled” Focus List
twodo://x-callback-url/showScheduled
Show List
Show List with a given name.
twodo://x-callback-url/showList
?name=
The name of the list.
Add New Task
Launch the app with the New Task Screen.
twodo://x-callback-url/addNewTask
?ignoreDefaults=
Should the ”Ignore Due Date Defaults” be ignored
Search
Launch the app with Search pre filled.
twodo://x-callback-url/search
?text=
The text to search for. Can be just text or something like ”type:overdue”
Get Task Unique Identifier
Returns the internally used unique identifier for the task. x-success is filled with the a key named ”uid”
twodo://x-callback-url/getTaskID
?task=
Known task’s title.
&forList=
The list containing the task.
&saveInClipboard=
Should the UID be saved in the clipboard.
Paste Text
Turn text into tasks.
twodo://x-callback-url/paste
?text* =
The text to paste
&inProject=
Title of a project to paste into.
&forList=
List that contains the project
Add Task
twodo://x-callback-url/add
?task=
Title of the taks
&type=
Type of taks to create.
&forList=
Name of an existing list in app, case-insensitive. Default list or the currently visible list on screen is selected if not used.
&forParentName=
The name of the project or checklist you wish to add this task to. When using this parameter, you must also provide the name of the List this project belongs to, by using the forList parameter.
&forParentTask=
:The internally used, unique identifier of a task. If supplied, this task will be added as a sub-task to the parent task. If the parent task was previously created as a normal task (vs. a project or a checklist), the parent task will automatically be converted into a project for you.
¬e=
Notes for the task
&priority=
&starred=
&tags=
Comma separated list of tags to assign to the task.
&locations=
Comma separated list of locations to assign to the task.
&due=
Due Date. Supports the format below:
&dueTime=
Due Time. Supports format HH:mm or hh:mm am/pm.
&start=
Start Date and time. Supports the format below:
&repeat=
&action=
Supports the following formats:
&picture=
This can be one of two things:
&audio=
Prvide a base64 encoded audio attachment
&ignoreDefaults=
&useQuickEntry=
&saveInClipboard=
The newly created task’s unique identifier (UID) will be saved in the clipboard for easier retrieval.
New Sheet
Creates a new sheet.
ulysses://x-callback-url/new-sheet
?text=
The contents that should be inserted to the new sheet. Contents are imported as Markdown by default.
&group=
Specifies the group the new sheet should be inserted to. This argument can be set to one of the following values:
&format=
Specifies the format of the imported text. One of:
&index=
The position of the new sheet in its parent group. Use 0 to make it the first sheet.
New Group
Creates a new group.
ulysses://x-callback-url/new-group
?name=
The name of the group to be created
&parent=
Specifies the parent group the new group should be inserted to. This argument can be set to one of the following values:
&index=
The position of the new group in its parent group. Use 0 to make it the first group.
Insert
Inserts or appends text to a sheet.
ulysses://x-callback-url/insert
?id=
The identifier of the sheet the text should be inserted to.
&text=
The contents that should be inserted to the new sheet. Must be URL-encoded. Contents are imported as Markdown by default.
&format=
Specifies the format of the imported text. One of:
&position=
Optional. Set ”begin” or ”end” in order to insert text at the beginning of a document. If not given, the text is appended.
&newline=
Specifies how newlines should be inserted to the text:
Attach Note
Creates a new note attachment on a sheet.
ulysses://x-callback-url/attach-note
?id=
The identifier of the sheet the text should be inserted to.
&text=
The contents that should be inserted to the new sheet. Must be URL-encoded. Contents are imported as Markdown by default.
&format=
Specifies the format of the imported text. One of:
Update Note
Changes an existing note attachment on a sheet. Requires authorization.
ulysses://x-callback-url/update-note
?id=
The identifier of the sheet the text should be inserted to.
&text=
The contents that should be inserted to the new sheet. Must be URL-encoded. Contents are imported as Markdown by default.
&format=
Specifies the format of the imported text. One of:
&index=
The position of the note to change. Use 0 for the first note, 1 for the second note, and so on.
Remove Note
Removes a note attachment from a sheet. Requires authorization.
ulysses://x-callback-url/remove-note
?id=
The identifier of the sheet from which a note should be removed.
&index=
The position of the note to remove. Use 0 for the first note, 1 for the second note, and so on.
Attach Image
Creates a new image attachment on a sheet.
ulysses://x-callback-url/attach-image
?id=
The identifier of the sheet the image should be attached to.
&image=
The image data that should be used. The data must use base64 encoding. Make sure that the base64-encoded data is also URL encoded.
&format=
The format of the provided image (use an image path extension, like png, pdf, jpg, raw, gif).
&filename=
A filename the image format should be detected from. Either the argument format or filename must be provided.
Attach Keywords
Adds one or more keywords to a sheet.
ulysses://x-callback-url/attach-keywords
?id=
The identifier of the sheet the keywords should be attached to.
&keywords=
A comma separated list of keywords that should be attached to the sheet.
Remove Keywords
Removes one or more keywords from a sheet. Requires authorization.
ulysses://x-callback-url/remove-keywords
?id=
The identifier of the sheet the keywords should be removed from.
&keywords=
A comma separated list of keywords that should be removed from the sheet.
Set Group Title
Changes the title of a group. Requires authorization.
ulysses://x-callback-url/set-group-title
?group=
The group for which the title should be changed. This argument can be set to one of the following values:
&title=
The new title
Set Sheet Title
Changes the first paragraph of a sheet. Requires authorization. If the sheet has a first paragraph with the requested type, the paragraph contents will be changed (a heading replaces any existing heading). Otherwise, a new paragraph with the requested type and contents will be inserted at the beginning of the sheet.
ulysses://x-callback-url/set-sheet-title
?sheet=
The identifier of the sheet for which the title should be changed.
&type=
The type of paragraph to use for the title. This argument can be set to one of the following values:
&title=
The new title
Move
Moves an item (sheet or group) to a target group and/or to a new position. Requires authorization.
ulysses://x-callback-url/move
?id=
The identifier of the item (sheet or group) that should be moved.
&targetGroup=
Optional if ”index” is set. The group where the item should be moved. This argument can be set to one of the following values:
&index=
Optional if ”targetGroup” is set. The position of the item in its target group. Use 0 to make it the first item.
Copy
Copies an item (sheet or group) to a target group and/or to a new position.
ulysses://x-callback-url/copy
?id=
The identifier of the item (sheet or group) that should be copied.
&targetGroup=
Optional if ”index” is set. The group where the item should be copied. This argument can be set to one of the following values:
&index=
Optional if ”targetGroup” is set. The position of the item in its target group. Use 0 to make it the first item.
Trash
Moves an item (sheet or group) to the trash. Requires authorization.
ulysses://x-callback-url/trash
?id=
The identifier of the item (sheet or group) that should be moved to the trash.
Get Item (Group)
Retrieves information about a group. Requires authorization.
ulysses://x-callback-url/get-item
?id=
The identifier of the group for which to retrieve information.
&recursive=
Determines whether the result should include all sub-groups of the group. The allowed values are:
&x-success=
The ”x-success” callback retrieves an argument ”item”. The value is a URL-encoded JSON object providing information on the requested group with the following structure.
Get Item (Sheet)
Retrieves information about a sheet. Requires authorization.
ulysses://x-callback-url/get-item
?id=
The identifier of the item sheet for which to retrieve information.
&x-success=
The ”x-success” callback retrieves an argument ”item”. The value is a URL-encoded JSON object providing information on the requested sheet with the following structure.
Get Root Items
Retrieves information about the root sections. Can be used to get a full listing of the entire Ulysses library. Requires authorization.
ulysses://x-callback-url/get-root-items
?recursive=
Determines whether the result should be a deep listing of the entire Ulysses library. The allowed values are ”YES” and ”NO”. Defaults to ”YES”.
&x-success=
The ”x-success” callback retrieves an argument ”items”. The value is a URL-encoded JSON array. It contains an info object for each section such as „iCloud”, „On My iPad”, and one for each external folder.
Read Sheet
Retrieves the contents (text, notes, keywords) of a sheet. Requires authorization.
ulysses://x-callback-url/read-sheet
?id=
The identifier of the sheet that should be read.
&text=
Determines whether the full text of the sheet should be included in the result. The allowed values are ”YES” and ”NO”. Defaults to ”NO”.
&x-success=
The ”x-success” callback retrieves an argument ”sheet”. The value is a URL-encoded JSON object. It has the following structure:
&Open=
Opens an item (sheet or group) with a particular identifier in Ulysses.
Open All
Opens the special “All” group
ulysses://x-callback-url/open-all
Open Recent
Opens the special “Last 7 days” group
ulysses://x-callback-url/open-recent
Open Favorites
Opens the special “Favorites” group
ulysses://x-callback-url/open-favorites
Stream
Plays the stream provided by the ”url” parameter
vlc-x-callback://x-callback-url/stream
?url=
The URL to stream
Download
Download the file provided by the ”url” parameter
vlc-x-callback://x-callback-url/download
?url=
The URL to stream
&filename=
VLC will store the file under the given filename.
Open Workflow
Launch the app to the state when it was last used.
workflow://
Create A New Workflow
Jump to My Workflows and create an empty new workflow.
workflow://create-workflow
Open A Workflow
Launch the app to a particular workflow in your collection.
workflow://open-workflow
?name=
The name of the workflow
Run A Workflow
This functionality may be useful in automation systems that extend beyond Workflow itself, so other apps can run a workflow in your collection. Or, you could utilize this URL in a task manager like OmniFocus or Todoist for running a workflow as one step in a project.
workflow://x-callback-url/run-workflow
?name=
The name of the workflow
&input=
This value determines what will be provided as input to the beginning of the workflow.
&text=
When the ”input” parameter is set to ”text” this text is used as input to the workflow.
&x-success=
When the run was successful the callback will be called with
&x-error=
When there was an error the callback will be called with
Import A Workflow
Workflow also has the ability to accept .wflow files and import them into My Workflows. This is useful, for example, if you would like to share a workflow online and provide a link for others to instantly add it to their library.
workflow://x-callback-url/import-workflow
?url=
A URL pointing to the .wflow file you want to import.
&name=
What to name the new workflow. If not provided, the workflow filename is used.
&silent=
By default, the imported workflow will be opened and displayed to the user. Set this parameter to ”true” to import without opening the workflow.
&x-success=
When the run was successful the callback will be called with
&x-error=
When there was an error the callback will be called with
Open Gallery
Open workflow on the main page of the gallery.
workflow://gallery
Search Gallery
Search the gallery
workflow://gallery/search
?query=
The query to search for
Writing files
Write to existing or new files.
working-copy://x-callback-url/write
?key* =
Secret URL key to avoid unauthorized command execution.
&repo=
Repository name or remote URL of repository. You will have to pick a repository if this parameter is missing.
&path=
Path of file written to relative to repository root without leading slash. You are asked to pick/create a file if this parameter is missing.
&text=
Text written to file. The text parameter is transferred as UTF-8 but will be written in the encoding of the existing file or UTF-8 for new files. If you do not include either a text or base64 parameter the clipboard content is written.
&base64=
Binary data written to file in base64 format. If you do not include either a text or base64 parameter the clipboard content is written.
&askcommit=
Ask to commit and push after writing.
&append=
Append to existing file instead of overwriting.
&overwrite=
To avoid loosing information the command refuses to write to files that have uncommitted changes and this parameter changes this behaviour.
&filename=
When path hasn't been provided and user picks where to save, this parameter is the suggested filename of the new file.
&uti=
Universal Type Identifier expected of destination file. This is only used when path hasn't been provided and user picks where to save. User will be warned before picking a file with extension that doesn't match UTI. Default value is public.plain-text or public.item depending on whether content is specified with text or base64.
Reading files
You can get the contents of text or binary files.
working-copy://x-callback-url/read
?key* =
Secret URL key to avoid unauthorized command execution.
&repo=
Repository name or remote URL of repository. You will have to pick a repository if this parameter is missing.
&path=
Path of file relative to repository root without leading slash. You are asked to pick a file if this parameter is missing.
&base64=
Binary data written to file in base64 format. If you do not include either a text or base64 parameter the clipboard content is written.
&uti=
Universal Type Identifier expected of picked file. This is only used when path hasn't been provided and user picks what to read. User will be warned before picking a file with extension that doesn't match UTI. Default value for uti is 'public.plain-text' but this is changed to 'public.item' if base64 indicates that you accept binary results.
Moving files
Move or rename files within a repository.
working-copy://x-callback-url/move
?key* =
Secret URL key to avoid unauthorized command execution.
&repo* =
Repository name or remote URL of repository.
&source* =
Path of source file relative to repository root without leading slash.
&destination* =
Path of destination file relative to repository root without leading slash.
Committing changes
Commit files, directories or entire repository.
working-copy://x-callback-url/commit
?key* =
Secret URL key to avoid unauthorized command execution.
&repo* =
Repository name or remote URL of repository.
&path=
Used to specify the files to take into account, where a missing or empty parameter means the entire repository is checked for modified files to commit.
&message* =
Supply a message parameter for the commit message and formatting/wrapping this message in accordance with best practices is your responsibility.
&limit=
To avoid accidentally committing unexpected changes the limit parameter is checked and if there are more changed files covered by path than allowed by limit the commit fails. The default is limit=1 but you can set it to large values if you intentionally want to commit all changed files.
Push to remote
Send commits back to the origin remote.
working-copy://x-callback-url/push
?key* =
Secret URL key to avoid unauthorized command execution.
&repo* =
Repository name or remote URL of repository. Push all repositories remotes by using wildcards on the form repo=* where the asterix matches one or more characters. These wildcards are only resolved against name, not remote URLs.
&remote=
Push to other remotes than origin with this parameter.
Pull from remote
Fetch and merge changes from remote.
working-copy://x-callback-url/pull
?key* =
Secret URL key to avoid unauthorized command execution.
&repo* =
Repository name or remote URL of repository. Pull all repositories remotes by using wildcards on the form repo=* where the asterix matches one or more characters. These wildcards are only resolved against name, not remote URLs.
&remote=
Pull from other remotes than origin with this parameter.
Open
Open WOWidget app.
wowidget://
Share
Share widget.
wowidget://share
?u* =
Valid url. URL encoded string.
&n* =
Name, title. URL encoded string.
&t* =
Type of content. Number.
&s* =
Slot. Number between 1 and 5 included.
&c=
Optional config. URL encoded json string. See documentation.