URL Scheme

GoodLinks registers the goodlinks:// URL scheme and supports for integration with other apps via the x-callback-url protocol. The format for a URL action looks like this:

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

Supported x-callback parameters: x-success, x-error and x-cancel.

GoodLinks supports the following actions:

• save
• open
• pick
• last
• random
• unread
• starred
• untagged
• read
• tag

save

Save a link.

Parameters

• url optional The URL of the link. If not specified, GoodLinks will look for URL in the clipboard.
• title optional The title for the link.
• summary optional The summary for the link.
• tags optional List of tags, separated by spaces.
• starred optional Valid values are "1" and "true". If specified, the link will be added to Starred.
• read optional Valid values are "1" and "true". If specified, the link will be marked as read.
• quick optional Valid values are "1" and "true". If specified, GoodLinks will save the link without showing any UI, otherwise the link editor screen will be shown.

Examples

• goodlinks://x-callback-url/save?url=https%3A%2F%2Fapple.com&starred=1&tags=apple%20ios

  Save the specified URL, tag it with tags "apple" and "ios", add it to Starred.

• goodlinks://x-callback-url/save?quick=1

  Quick save the URL in the clipboard.

open

Open a link in the GoodLinks app.

Parameters

• url required The URL of the link.

pick

Return details of a link.

Parameters

• url-param optional The URL will be passed to the x-success URL using this parameter name. Default value is "url".
• title-param optional The title will be passed to the x-success URL using this parameter name. Default value is "title".
• summary-param optional The summary will be passed to the x-success URL using this parameter name. Default value is "summary".

last

Open the last unread link in the GoodLinks app.

random

Open a random unread link in the GoodLinks app.

unread

Show Unread list in the GoodLinks app.

starred

Show Starred list in the GoodLinks app.

untagged

Show Untagged list in the GoodLinks app.

read

Show Read list in the GoodLinks app.

tag

Show links tagged with the specified tag in the GoodLinks app.

Parameters

• name required Tag name.

Example

• goodlinks://x-callback-url/tag?name=apple