n8n integration setup
Build n8n automations with the Nimriz node using OAuth or API-key credentials, trigger nodes, and link operation nodes.
Nimriz provides an official community node for n8n that lets you build automations around link creation, click/scan events, and link management.
The Nimriz community node is published on npm as
n8n-nodes-nimriz. Credentials support Nimriz OAuth2 and workspace API keys.
Prerequisites
- A Nimriz workspace on Professional plan or higher.
- An n8n instance (self-hosted or n8n Cloud).
Install the node
You can review the dashboard setup summary at IntegrationsAutomationn8n, then finish the connection in n8n.
On self-hosted n8n, go to Settings > Community Nodes > Install and enter n8n-nodes-nimriz. On n8n Cloud, search for Nimriz in the nodes panel.
After installing on a self-hosted instance, restart n8n. The Nimriz and Nimriz Trigger nodes will appear in the node selector.
Set up credentials
- In n8n, add a new credential from Settings > Credentials > Add Credential, or directly on a Nimriz node.
- Use Nimriz OAuth2 API when your Nimriz setup includes a Client ID and Client Secret for your n8n callback URL.
- Use Nimriz API when you want to connect with a workspace API key from IntegrationsDeveloperBackend API access.
- Save the credential, then click Test to confirm the connection succeeds.
For self-hosted n8n, the OAuth callback URL must be an exact HTTPS URL from your n8n instance. Send that callback URL to integrations@nimriz.com so it can be registered before you create the OAuth credential.
Existing API-key workflows keep working. To reconnect with OAuth, create a new Nimriz OAuth2 credential, then switch each Nimriz node from API Key to OAuth2 and select the new credential.
Disconnect or reconnect
- OAuth credential: revoke the Nimriz grant from your workspace principal list, then create a new n8n credential when you want to reconnect.
- API-key credential: revoke or rotate the workspace API key from IntegrationsDeveloperBackend API access, then update the n8n credential.
OAuth connections request links:read, links:write, domains:read, analytics:read, webhooks:read, webhooks:write, connections:read, and connections:write.
Trigger node: Nimriz Trigger
The trigger node creates a webhook subscription on your workspace and starts the workflow when the selected event fires.
| Event | Description |
|---|---|
| Link Created | A new short link is created |
| Link Updated | A link is updated |
| Link Takedown Updated | A link's availability changes due to moderation |
| Domain Verification Updated | A domain readiness state changes |
| Link Clicked | A short link is clicked (bot traffic excluded) |
| QR Code Scanned | A QR code is scanned (bot traffic excluded) |
Operations node: Nimriz
The main operations node works on two resources: Link and Connection.
Link operations
| Operation | Description |
|---|---|
| Create | Create a new short link |
| Get | Get a link by ID |
| Find | Find a link by short URL |
| List | List recent links for the workspace |
| Get Analytics | Get click and QR-scan analytics for a link |
| Check Slug | Check if a slug is available on a domain |
| Update Slug | Change the slug on a link |
| Update Destination | Change the destination URL on a link |
| Update Expiration | Set or remove a link's expiration |
| Update Password | Set or remove password protection on a link |
Connection operations
Manage outbound integration connections in your workspace:
| Operation | Description |
|---|---|
| Create | Create a connection |
| Get | Get a connection |
| List | List connections |
| Test | Test a connection |
| Update | Update a connection |
| Delete | Delete a connection |
Example workflow: Bulk link creation from Google Sheets
- Trigger: Schedule Trigger (run daily).
- Node: Google Sheets > Read Rows (read destination URLs).
- Node: Nimriz > Create (create a short link for each row).
- Node: Google Sheets > Update Row (write the returned
short_urlback).
Example workflow: Click notification router
- Trigger: Nimriz Trigger > Link Clicked.
- Node: Switch (route by
data.touch_typeordata.country). - Node A: Slack > Send Message (for QR scans).
- Node B: Email > Send (for link clicks from specific countries).
Related guides
Related next steps
Ready to test this setup?
Create an account to try the workflow, or compare plans when the setup needs higher limits, integrations, or team controls.