Ulysses URL Scheme

Updated 10012022-013233



Ulysses X-Callback-URL Support

Captured: 2016-03-13 at 19:10 from ulyssesapp.com

Ulysses supports x-callback-urls, allowing other apps to trigger certain actions in Ulysses such as creating new sheets.

The URL Scheme

The used scheme is ulysses://. Every action can be called through the x-callback-url API using the following format:

ulysses://x-callback-url/[action]?[x-callback parameters]&[parameters]

For more information regarding the URL format, see the official specification.

Available Actions

In the following, all available actions are detailed. Please note that for reasons of clarity, the examples are not yet URL escaped. For instance, all whitespace must be replaced with %20.

new-sheet

Creates a new sheet.

Parameters:

Example: [ulysses://x-callback-url/new-sheet?text=My new sheet](ulysses://x-callback-url/new-sheet?text=My%20new%20sheet)

new-group

Creates a new group.

Parameters:

Example: [ulysses://x-callback-url/new-group?name=My Group](ulysses://x-callback-url/new-group?name=My%20Group)

open-group

Open a group with a particular name in Ulysses.

Parameters:

Example: [ulysses://x-callback-url/open-group?group=My Group](ulysses://x-callback-url/open-group?group=My%20Group)

open-all, open-recent, open-favorites

Opens the special groups "All", "Last 7 Days" and "Favorites".

x-callback Parameters

In addition to action parameters, generic x-callback parameters can also be included. All of these are optional.

Example: If a new sheet should be created and the user wants to return to the calling app (say, "SourceApp") afterwards, use the following URL (line breaks are for legibility):

ulysses://x-callback-url/new-sheet?
    x-source=SourceApp&
    x-success=sourceapp://x-callback-url/success&
    group=Lecture Notes