search

cjlm / send-to-workflowy

Unofficial API to send to Workflowy
https://send-to-workflowy.netlify.app/
Other
33 stars 6 forks source link
productivity send-to-workflowy workflowy

readme

An unofficial way to send to WorkFlowy from anywhere.

Intro

This repository allows you to send to your WorkFlowy account from a variety of different sources:

It helps you save links and text for later so you can concentrate on the task in hand.

⚠️ Disclaimer ⚠️

WorkFlowy doesn't have an official API so send-to-workflowy needs some configuration to talk to WorkFlowy. It doesn't store any of your login information or WorkFlowy data but it's up to you to keep your Session ID secure.

How to use

For most users send-to-workflowy is a web application hosted at https://send-to-workflowy.netlify.app/

Simply add your Session ID and Parent ID on the Settings panel to send to your WorkFlowy. These IDs are stored in your browser cache for convenience. They are used to communicate with your WorkFlowy but otherwise are not tracked by send-to-workflowy. See Configuration for details on finding these IDs.

Configuration

Session ID

send-to-workflowy uses a session ID to talk to your WorkFlowy account. The easiest way to do this is to copy it from the browser with the following steps:

Note that you should treat this session ID as if it were a password. It should not be shared with anyone or posted publicly. Each Session ID expires after a few months.

Parent ID

All nodes in WorkFlowy have a parent ID. You can provide this to send-to-workflowy to always place new nodes under a node with a particular parent ID.

To find your parent ID:

Integrations

The Settings panel also provides a link to the iOS shortcut and bookmarklet to make it even easier to send to WorkFlowy from your phone or without going to the site. Once you've configured your Session ID and Parent ID the integration icons on the Settings page are ready to use.

iOS Shortcut

If you select the Apple link you'll be redirected to an iOS shortcut hosted in iCloud. Due to limitations this is the easiest way to create your new send-to-workflowy shortcut.

Scroll all the way down to accept the shortcut. On the next page you'll be prompted to add your Session ID and Parent ID. The shortcut expects these in the following form

<sessionId>
<parentId>

The send-to-workflowy web app should have already put these on the clipboard for you so just paste them into the prompt. Note these will not be leaving your device, just used to configure the shortcut.

Bookmarklet

This bookmarklet can be dragged to your bookmark bar. Again it's configured using the Session and Parent IDs provided in the webapp (locally) – it will send the current URL to your WorkFlowy.

Android

This integration isn't ready yet. Please let me know if there's a preferred way to do this on Android.

In the meantime it's possible to add bookmarklets to Chrome on Android.

Self-hosted

The most secure way to use send-to-workflowy is to host it yourself. This repository can be deployed to Netlify with the following URL.

The environment variables SESSIONID and PARENTID can be configured in the Netlify configuration to avoid the need to provide these to the web application in the browser.

Future Roadmap

Dev Improvements

Acknowledgements

There's a decade of previous attempts at an unofficial API of sorts for WorkFlowy. I am most indebted to Malcolm Ocean's opusfluxus for the original code forked to make this repository. Thanks to him and his collaborators.

Thanks to Jesse Patel & team for WorkFlowy ❤️