Nimriz

n8n

Build automations with the official Nimriz community node for n8n, including trigger and operations nodes.

Nimriz provides an official community node for n8n that lets you build automations around link creation, click/scan events, and link management.

Prerequisites

  • A Nimriz workspace on Professional plan or higher.
  • A workspace API key from Dashboard > Settings > Integrations > API access.
  • An n8n instance (self-hosted or n8n Cloud).

Install the node

Install the community node from the n8n community nodes panel or via npm:

npm install n8n-nodes-nimriz

After installing, restart your n8n instance. The Nimriz and Nimriz Trigger nodes will appear in the node selector.

Set up credentials

  1. In n8n, go to Settings > Credentials > Add Credential.
  2. Search for Nimriz API.
  3. Enter your API Key (workspace API key) and your Workspace ID.
  4. Save the credential.

Trigger node: Nimriz Trigger

The trigger node creates a webhook subscription on your workspace and starts the workflow when the selected event fires.

EventDescription
Link CreatedA new short link is created
Link UpdatedA link is updated
Link Takedown UpdatedA link's availability changes due to moderation
Domain Verification UpdatedA domain readiness state changes
Link ClickedA short link is clicked (bot traffic excluded)
QR Code ScannedA QR code is scanned (bot traffic excluded)

Operations node: Nimriz

The main operations node supports these actions on the Link resource:

OperationDescription
CreateCreate a new short link
FindFind a link by short URL
GetGet a link by ID
ListList recent links for the workspace
Update SlugChange the slug on a link
Update DestinationChange the destination URL on a link
Check SlugCheck if a slug is available on a domain

Example workflow: Bulk link creation from Google Sheets

  1. Trigger: Schedule Trigger (run daily).
  2. Node: Google Sheets > Read Rows (read destination URLs).
  3. Node: Nimriz > Create (create a short link for each row).
  4. Node: Google Sheets > Update Row (write the returned short_url back).

Example workflow: Click notification router

  1. Trigger: Nimriz Trigger > Link Clicked.
  2. Node: Switch (route by data.touch_type or data.country).
  3. Node A: Slack > Send Message (for QR scans).
  4. Node B: Email > Send (for link clicks from specific countries).

Related guides