Back to Notenik.app


The Notenik Knowledge Base

13. Integration ↑

13.1 Custom URL Scheme

Notenik has its own custom URL scheme, which can be invoked by other apps as a means of integrating Notenik with these other applications.

Note that URLs must in general be percent encoded. The most common encoding is done by replacing each space with %20.

The following commands are supported.

Open

This command opens a Collection and, optionally, a specific Note within that Collection and. optionally, at attachment for that Note.

Following is a sample URL:


notenik://open?shortcut=todo&id=pickupmilk

Let’s break this down:

The open command accepts the following parameters following the question mark:

An easy way to obtain a complete URL that can be used to later open a specific Note is to right-click the Note’s row on the List tab within Notenik, and then select Copy Notenik URL from the contextual menu that will pop up. This will copy a complete Notenik URL to the clipboard, from which it can then be pasted into another location.

To obtain a URL to open the Collection only, without specifying a specific Note, select Copy Notenik URL for Collection from beneath the Collection menu, then paste into the desired location.

Add

Following is a sample URL:


notenik://add?shortcut=todo&title=Pick%20up%20milk&body=You%20gotta

Again, let’s break this down.

Other fields may also be specified for a new Note, using a similar label=value convention.

Expand

This command expands the specified tag on the Tags tab of the Collection window.

Following is a sample URL:


notenik://expand?shortcut=todo&tag=shopping

Let’s break this down:

The expand command accepts the following parameters following the question mark:

Help

Following is a sample URL:


notenik://help?id=versionhistory

Once more, let’s break this down:

The query string is optional. If it is not supplied, then the Knowledge Base will be opened at the first Note in the Collection.

Settings

Following is a sample URL:


notenik://settings

This command simply brings up the overall Application Settings window, to allow the user to adjust one or more of the global settings.


Next: APIs for Hookmark Integration