Skip to content

Integrations

n8n nodes

Create, update and delete short links, read their analytics and start workflows when a link is created, with the iShortn community nodes for n8n.

The iShortn community nodes for n8n let your workflows shorten URLs, manage links and read click analytics, and start a workflow whenever a link is created. They use the iShortn API, so they need an API key, and API keys need a Pro or Ultra plan.

The package is n8n-nodes-ishortn. It adds two nodes:

  • iShortn: create, get, list, update and delete links, and get a link's analytics.
  • iShortn Trigger: starts a workflow when a new link is created.

Install

In n8n, as an instance owner or admin:

  1. Open Settings → Community Nodes.
  2. Click Install.
  3. Enter n8n-nodes-ishortn, confirm that you understand the risks of installing community nodes, and click Install.

The nodes then show up when you search for iShortn in the nodes panel. To install them on a self-hosted instance without the UI (for example in queue mode), run npm install n8n-nodes-ishortn in ~/.n8n/nodes and restart n8n. See n8n's guide to installing community nodes.

Create an API key

  1. Open Settings in the dashboard and scroll to API Keys.
  2. Click Create API Key and copy the key from the dialog. It's shown once.

The key works in your personal workspace: links created from n8n are added there, and the other operations only find links in it. See Which links the API can reach.

Connect n8n

  1. Add an iShortn node to a workflow and open Credential to connect with → Create new credential.
  2. Paste the key into API Key.
  3. Leave Base URL as https://ishortn.ink. Change it only if you host iShortn yourself.
  4. Click Save. n8n tests the key with Get your account and shows Connection tested successfully.
FieldRequiredDescription
API KeyYesThe key from Settings. Sent in the x-api-key header.
Base URLNoWhere iShortn runs. Defaults to https://ishortn.ink.

Operations

ResourceOperationWhat it doesAPI endpoint
LinkCreateShortens a URL. Optional fields: alias, domain, expiry date, click limit, activation date, password and UTM parameters.POST /api/v1/links
LinkGetGets a link by its alias and domain.GET /api/v1/links/{alias}
LinkGet ManyLists your links, newest first. Turn on Return All to fetch every page, or set Limit (up to 100). Filter by domain.GET /api/v1/links
LinkUpdateChanges a link's destination, alias, expiry date, click limit or activation date. Clear Settings removes an expiry date, click limit or activation date.PATCH /api/v1/links/{alias}
LinkDeleteDeletes a link. Returns { "deleted": true }.DELETE /api/v1/links/{alias}
AnalyticsGetGets a link's total clicks, daily clicks and breakdowns by country, city, device, browser, OS and referrer.GET /api/v1/analytics/{alias}

A link is identified by its alias and domain. Leave Domain empty to use the default domain from Settings → General, or isht.app. See Domains.

Dates you pick in Expires At and Activates At are read in the workflow's time zone. Plan rules are the same as in the dashboard: activation dates and passwords need Pro or Ultra, UTM parameters need Ultra, and links created from n8n count toward your monthly link limit. See Plans and limits.

The iShortn Trigger node has one event, New Link. It checks your newest links on the schedule you set in Poll Times and starts the workflow once for each link created since the last check, oldest first. Each item has the same fields as Get a link returns, such as shortLink, url and alias.

  • It sees links created anywhere in your personal workspace: in the dashboard, through the API or from another workflow.
  • When you activate the workflow, it records the links you already have and only fires for links created after that.
  • Fetch Test Event returns your newest link so you can map its fields, without changing what the trigger has recorded.
  • Set Domain to only watch links on one domain.

The API doesn't return link IDs, so the trigger recognises links by their short link. Renaming your newest link with a new alias makes it fire again as a new link.

Example: shorten every new row in Google Sheets

This workflow adds a short link next to each URL added to a sheet. The sheet has a URL column and an empty Short link column.

  1. Add a Google Sheets Trigger node with the event Row Added and pick your document and sheet.
  2. Add an iShortn node with resource Link and operation Create. Set URL to the expression {{ $json.URL }}. Optionally add Domain under Additional Fields.
  3. Add a Google Sheets node with the operation Update Row. Match rows on the URL column with {{ $('Google Sheets Trigger').item.json.URL }} and set Short link to {{ $json.shortLink }}.
  4. Activate the workflow.

To go the other way, start with an iShortn Trigger and add a Google Sheets node with Append Row to log every new link to a sheet.

Errors

When a request fails, n8n shows the HTTP status as the error and the API's message under it. The most common messages:

MessageWhat to do
Invalid or missing API keyThe key was mistyped or deleted. Create a new one in Settings and update the credential.
API access requires ProThe key's account isn't on a paid plan. See API access by plan.
Link not foundNo link with that alias on that domain in your personal workspace. Check the Domain field.
Domain not available for this API keyThe domain isn't a platform domain or an active custom domain in your personal workspace.
Rate limit exceeded. Retry in N seconds.Too many requests in a short time. Turn on Retry On Fail in the node's settings, or space out the workflow. See Rate limits.

Other errors, such as an alias that's already taken, are listed in Responses and errors.

Something missing or unclear? Email support@ishortn.ink.