nostr

Workflow Automation for Nostr

Rod

Rod

Workflow Automation for Nostr

Tldr

  • Nostr is an open and interoperable protocol
  • You can integrate it with workflow automation tools to augment your experience
  • n8n is a great low/no-code workflow automation tool which you can host yourself
  • Nostrobots allows you to integrate Nostr into n8n
  • In this blog I create some workflow automations for Nostr
  • A simple form to delegate posting notes
  • Push notifications for mentions on multiple accounts
  • Push notifications for your favourite accounts when they post a note
  • All workflows are provided as open source with MIT license for you to use

Inter-op All The Things

Nostr is a new open social protocol for the internet. This open nature exciting because of the opportunities for interoperability with other technologies. In Using NFC Cards with Nostr I explored the nostr: URI to launch Nostr clients from a card tap.

The interoperability of Nostr doesn't stop there. The internet has many super-powers, and Nostr is open to all of them. Simply, there's no one to stop it. There is no one in charge, there are no permissioned APIs, and there are no risks of being de-platformed. If you can imagine technologies that would work well with Nostr, then any and all of them can ride on or alongside Nostr rails.

My mental model for why this is special is Google Wave ~2010. Google Wave was to be the next big platform. Lars was running it and had a big track record from Maps. I was excited for it. Then, Google pulled the plug. And, immediately all the time and capital invested in understanding and building on the platform was wasted.

This cannot happen to Nostr, as there is no one to pull the plug, and maybe even no plug to pull.

So long as users demand Nostr, Nostr will exist, and that is a pretty strong guarantee. It makes it worthwhile to invest in bringing Nostr into our other applications.

All we need are simple ways to plug things together.

Nostr and Workflow Automation

Workflow automation is about helping people to streamline their work. As a user, the most common way I achieve this is by connecting disparate systems together. By setting up one system to trigger another or to move data between systems, I can solve for many different problems and become way more effective.

n8n for workflow automation

Many workflow automation tools exist. My favourite is n8n. n8n is a low/no-code workflow automation platform which allows you to build all kinds of workflows. You can use it for free, you can self-host it, it has a user-friendly UI and useful API. Vs Zapier it can be far more elaborate. Vs Make.com I find it to be more intuitive in how it abstracts away the right parts of the code, but still allows you to code when you need to.

Most importantly you can plug anything into n8n: You have built-in nodes for specific applications. HTTP nodes for any other API-based service. And community nodes built by individual community members for any other purpose you can imagine.

Eating my own dogfood

It's very clear to me that there is a big design space here just demanding to be explored. If you could integrate Nostr with anything, what would you do?

In my view the best way for anyone to start anything is by solving their own problem first (aka "scratching your own itch" and "eating your own dogfood"). As I get deeper into Nostr I find myself controlling multiple Npubs – to date I have a personal Npub, a brand Npub for a community I am helping, an AI assistant Npub, and various testing Npubs. I need ways to delegate access to those Npubs without handing over the keys, ways to know if they're mentioned, and ways to know if they're posting.

I can build workflows with n8n to solve these issues for myself to start with, and keep expanding from there as new needs come up.

Running n8n with Nostrobots

I am mostly non-technical with a very helpful AI. To set up n8n to work with Nostr and operate these workflows should be possible for anyone with basic technology skills.

  • I have a cheap VPS which currently runs my HAVEN Nostr Relay and Albyhub Lightning Node in Docker containers,
  • My objective was to set up n8n to run alongside these in a separate Docker container on the same server, install the required nodes, and then build and host my workflows.

Installing n8n

Self-hosting n8n could not be easier. I followed n8n's Docker-Compose installation docs–

  • Install Docker and Docker-Compose if you haven't already,
  • Create your docker-compose.yml and .env files from the docs,
  • Create your data folder sudo docker volume create n8n_data,
  • Start your container with sudo docker compose up -d,
  • Your n8n instance should be online at port 5678.

n8n is free to self-host but does require a license. Enter your credentials into n8n to get your free license key. You should now have access to the Workflow dashboard and can create and host any kind of workflows from there.

Installing Nostrobots

To integrate n8n nicely with Nostr, I used the Nostrobots community node by Ocknamo.

In n8n parlance a "node" enables certain functionality as a step in a workflow e.g. a "set" node sets a variable, a "send email" node sends an email. n8n comes with all kinds of "official" nodes installed by default, and Nostr is not amongst them. However, n8n also comes with a framework for community members to create their own "community" nodes, which is where Nostrobots comes in.

You can only use a community node in a self-hosted n8n instance (which is what you have if you are running in Docker on your own server, but this limitation does prevent you from using n8n's own hosted alternative).

To install a community node, see n8n community node docs. From your workflow dashboard–

  • Click the "..." in the bottom left corner beside your username, and click "settings",
  • Cilck "community nodes" left sidebar,
  • Click "Install",
  • Enter the "npm Package Name" which is n8n-nodes-nostrobots,
  • Accept the risks and click "Install",
  • Nostrobots is now added to your n8n instance.

Using Nostrobots

Nostrobots gives you nodes to help you build Nostr-integrated workflows–

  • Nostr Write – for posting Notes to the Nostr network,
  • Nostr Read – for reading Notes from the Nostr network, and
  • Nostr Utils – for performing certain conversions you may need (e.g. from bech32 to hex).

Nostrobots has good documentation on each node which focuses on simple use cases.

Each node has a "convenience mode" by default. For example, the "Read" Node by default will fetch Kind 1 notes by a simple filter, in Nostrobots parlance a "Strategy". For example, with Strategy set to "Mention" the node will accept a pubkey and fetch all Kind 1 notes that Mention the pubkey within a time period. This is very good for quick use.

What wasn't clear to me initially (until Ocknamo helped me out) is that advanced use cases are also possible.

Each node also has an advanced mode. For example, the "Read" Node can have "Strategy" set to "RawFilter(advanced)". Now the node will accept json (anything you like that complies with NIP-01). You can use this to query Notes (Kind 1) as above, and also Profiles (Kind 0), Follow Lists (Kind 3), Reactions (Kind 7), Zaps (Kind 9734/9735), and anything else you can think of.

Creating and adding workflows

With n8n and Nostrobots installed, you can now create or add any kind of Nostr Workflow Automation.

  • Click "Add workflow" to go to the workflow builder screen,
  • If you would like to build your own workflow, you can start with adding any node. Click "+" and see what is available. Type "Nostr" to explore the Nostrobots nodes you have added,
  • If you would like to add workflows that someone else has built, click "..." in the top right. Then click "import from URL" and paste in the URL of any workflow you would like to use (including the ones I share later in this article).

Nostr Workflow Automations

It's time to build some things!

A simple form to post a note to Nostr

I started very simply. I needed to delegate the ability to post to Npubs that I own in order that a (future) team can test things for me. I don't want to worry about managing or training those people on how to use keys, and I want to revoke access easily.

I needed a basic form with credentials that posted a Note.

For this I can use a very simple workflow–

  • A n8n Form node – Creates a form for users to enter the note they wish to post. Allows for the form to be protected by a username and password. This node is the workflow "trigger" so that the workflow runs each time the form is submitted.
  • A Set node – Allows me to set some variables, in this case I set the relays that I intend to use. I typically add a Set node immediately following the trigger node, and put all the variables I need in this. It helps to make the workflows easier to update and maintain.
  • A Nostr Write node (from Nostrobots) – Writes a Kind-1 note to the Nostr network. It accepts Nostr credentials, the output of the Form node, and the relays from the Set node, and posts the Note to those relays.

Once the workflow is built, you can test it with the testing form URL, and set it to "Active" to use the production form URL. That's it. You can now give posting access to anyone for any Npub. To revoke access, simply change the credentials or set to workflow to "Inactive".

It may also be the world's simplest Nostr client.

You can find the Nostr Form to Post a Note workflow here.

Push notifications on mentions and new notes

One of the things Nostr is not very good at is push notifications. Furthermore I have some unique itches to scratch. I want–

  • To make sure I never miss a note addressed to any of my Npubs – For this I want a push notification any time any Nostr user mentions any of my Npubs,
  • To make sure I always see all notes from key accounts – For this I need a push notification any time any of my Npubs post any Notes to the network,
  • To get these notifications on all of my devices – Not just my phone where my Nostr regular client lives, but also on each of my laptops to suit wherever I am working that day.

I needed to build a Nostr push notifications solution.

To build this workflow I had to string a few ideas together–

  • Triggering the node on a schedule – Nostrobots does not include a trigger node. As every workflow starts with a trigger we needed a different method. I elected to run the workflow on a schedule of every 10-minutes. Frequent enough to see Notes while they are hot, but infrequent enough to not burden public relays or get rate-limited,
  • Storing a list of Npubs in a Nostr list – I needed a way to store the list of Npubs that trigger my notifications. I initially used an array defined in the workflow, this worked fine. Then I decided to try Nostr lists (NIP-51, kind 30000). By defining my list of Npubs as a list published to Nostr I can control my list from within a Nostr client (e.g. Listr.lol or Nostrudel.ninja). Not only does this "just work", but because it's based on Nostr lists automagically Amethyst client allows me to browse that list as a Feed, and everyone I add gets notified in their Mentions,
  • Using specific relays – I needed to query the right relays, including my own HAVEN relay inbox for notes addressed to me, and wss://purplepag.es for Nostr profile metadata,
  • Querying Nostr events (with Nostrobots) – I needed to make use of many different Nostr queries and use quite a wide range of what Nostrobots can do–
    • I read the EventID of my Kind 30000 list, to return the desired pubkeys,
    • For notifications on mentions, I read all Kind 1 notes that mention that pubkey,
    • For notifications on new notes, I read all Kind 1 notes published by that pubkey,
    • Where there are notes, I read the Kind 0 profile metadata event of that pubkey to get the displayName of the relevant Npub,
    • I transform the EventID into a Nevent to help clients find it.
  • Using the Nostr URI – As I did with my NFC card article, I created a link with the nostr: URI prefix so that my phone's native client opens the link by default,
  • Push notifications solution – I needed a push notifications solution. I found many with n8n integrations and chose to go with Pushover which supports all my devices, has a free trial, and is unfairly cheap with a $5-per-device perpetual license.

Once the workflow was built, lists published, and Pushover installed on my phone, I was fully set up with push notifications on Nostr. I have used these workflows for several weeks now and made various tweaks as I went. They are feeling robust and I'd welcome you to give them a go.

You can find the Nostr Push Notification If Mentioned here and If Posts a Note here.

In speaking with other Nostr users while I was building this, there are all kind of other needs for push notifications too – like on replies to a certain bookmarked note, or when a followed Npub starts streaming on zap.stream. These are all possible.

Use my workflows

I have open sourced all my workflows at my Github with MIT license and tried to write complete docs, so that you can import them into your n8n and configure them for your own use.

To import any of my workflows–

To configure them–

  • Prerequisites, credentials, and variables are all stated,
  • In general any variables required are entered into a Set Node that follows the trigger node,
  • Pushover has some extra setup but is very straightforward and documented in the workflow.

What next?

Over my first four blogs I explored creating a good Nostr setup with Vanity Npub, Lightning Payments, Nostr Addresses at Your Domain, and Personal Nostr Relay.

Then in my latest two blogs I explored different types of interoperability with NFC cards and now n8n Workflow Automation.

Thinking ahead n8n can power any kind of interoperability between Nostr and any other legacy technology solution. On my mind as I write this:

  • Further enhancements to posting and delegating solutions and forms (enhanced UI or different note kinds),
  • Automated or scheduled posting (such as auto-liking everything [Lyn Alden](Lyn Alden) posts),
  • Further enhancements to push notifications, on new and different types of events (such as notifying me when I get a new follower, on replies to certain posts, or when a user starts streaming),
  • All kinds of bridges, such as bridging notes to and from Telegram, Slack, or Campfire. Or bridging RSS or other event feeds to Nostr,
  • All kinds of other automation (such as [BlackCoffee](BlackCoffee ) controlling a coffee machine),
  • All kinds of AI Assistants and Agents,

In fact I have already released an open source workflow for an AI Assistant, and will share more about that in my next blog.

Please be sure to let me know if you think there's another Nostr topic you'd like to see me tackle.

GM Nostr.

Read more