Shlink
App · 9 actions
Shorten links on your own Shlink server from workflows, with custom slugs, tags, domains and limits, read their visits by day, referrer and country, and make QR codes. Start a workflow when a short link is visited, made, or reaches a number of visits.
Actions
| Action | What it does |
|---|---|
| Delete short URL | Delete a short URL and its visits from Shlink. |
| Find short URLs | Find short URLs by words in their address, title or code, by tag or by domain, newest or most visited first. |
| Get QR code | Make a QR code image of a short link, as a file to attach to an email, put on a poster or upload. |
| Get short URL | Get a short URL's details: where it goes, its title, tags and limits, and how many visits it has had. |
| Get visits | Count and list the visits to a short URL, a tag's short URLs or every short URL, in a period you choose, with visits per day and the referrers and countries they came from most. |
| List domains | List the domains short links can be made on, the default one first. |
| List tags | List every tag, A to Z, with how many short URLs and visits each has. |
| Shorten a link | Make a short link for a long address, such as a campaign link or a shared document, with your own ending, a title and tags, on the domain you choose, and limits on when and how often it works. |
| Update short URL | Change where a short URL goes, its title or tags, or when and how often it works. |
Delete short URL
Delete a short URL and its visits from Shlink. The short link stops working, and it can't be restored from Lodol.
Inputs
- Short URL
short_urltextRequired - The short link, such as https://s.example.com/spring-sale, or its short code (spring-sale) from another Shlink step or the trigger. Capitals matter.
- Domain
domaintext - The short URL's domain, when it isn't on the server's default domain and is named by its short code alone. Leave blank otherwise.
Outputs
deletedtrue/false- Whether the short URL was deleted
domaintext- The domain it was on
long_urltext- The address it opened
short_codetext- Its short code
short_urltext- The short link, which no longer works
titletext- Its title
visitsnumber- How many visits it had, deleted with it
Example output
{
"deleted": true,
"domain": "s.example.com",
"long_url": "https://example.com/spring-sale?utm_source=newsletter",
"short_code": "spring-sale",
"short_url": "https://s.example.com/spring-sale",
"title": "Spring sale",
"visits": 42
}Find short URLs
Find short URLs by words in their address, title or code, by tag or by domain, newest or most visited first.
Inputs
- Search for
searchtext - Words to find in the long URL, title, short code or tags. Leave blank for every short URL.
- Tags
tagslist - Only short URLs with any of these tags.
- Domain
domaintext - Only short URLs on this domain. Leave blank for every domain.
- Order
ordertext - Which come first. Defaults to newest.One of:
newest(Newest first),oldest(Oldest first),most_visited(Most visited first),least_visited(Least visited first),title(Title, A to Z). Default:newest. - Only working ones
active_onlytrue/false - Leave out short URLs past their Valid until date or their most visits.Default:
false. - How many
limitnumber - The most to list. Defaults to 25.From 1 to 100.
Outputs
countnumber- How many are listed
short_urlslist- The short URLs
totalnumber- How many there are in all
Example output
{
"count": 1,
"short_urls": [
{
"bot_visits": 3,
"created_at": "2026-11-06T10:00:00+00:00",
"domain": "s.example.com",
"human_visits": 39,
"long_url": "https://example.com/spring-sale?utm_source=newsletter",
"max_visits": 0,
"short_code": "spring-sale",
"short_url": "https://s.example.com/spring-sale",
"tags": [
"campaign",
"newsletter"
],
"title": "Spring sale",
"valid_since": "",
"valid_until": "2026-12-31T23:59:59+00:00",
"visits": 42
}
],
"total": 1
}Get QR code
Make a QR code image of a short link, as a file to attach to an email, put on a poster or upload.
Inputs
- Short URL
short_urltextRequired - The short link, such as https://s.example.com/spring-sale, or its short code (spring-sale) from another Shlink step or the trigger. Capitals matter.
- Domain
domaintext - The short URL's domain, when it isn't on the server's default domain and is named by its short code alone. Leave blank otherwise.
- Size
sizetext - How big the image is. Defaults to medium.One of:
small(Small (200 pixels)),medium(Medium (400 pixels)),large(Large (800 pixels)). Default:medium. - File type
file_formattext - PNG suits email and the web; SVG stays sharp at any size, for print. Defaults to PNG.One of:
png(PNG image),svg(SVG (sharp at any size, for print)). Default:png.
Outputs
content_typetext- The file's type, such as image/png
document_reftext- The QR code in Lodol, to pass to a later step
documentslist- The QR code image, in the shape steps that send or upload files expect
filenametext- The file's name, such as spring-sale-qr-code.png
short_codetext- Its short code
short_urltext- The short link the QR code opens
size_bytesnumber- The file's size in bytes
urltext- A link to the file in Lodol
Example output
{
"content_type": "image/png",
"document_ref": "doc_6f1d3c1e58a14c879a4b2f5e",
"documents": [
{
"content_type": "image/png",
"document_ref": "doc_6f1d3c1e58a14c879a4b2f5e",
"filename": "spring-sale-qr-code.png",
"size_bytes": 1234,
"url": "/actions/core/serve-document/doc_6f1d3c1e58a14c879a4b2f5e?teamId=0"
}
],
"filename": "spring-sale-qr-code.png",
"short_code": "spring-sale",
"short_url": "https://s.example.com/spring-sale",
"size_bytes": 1234,
"url": "/actions/core/serve-document/doc_6f1d3c1e58a14c879a4b2f5e?teamId=0"
}Get short URL
Get a short URL's details: where it goes, its title, tags and limits, and how many visits it has had.
Inputs
- Short URL
short_urltextRequired - The short link, such as https://s.example.com/spring-sale, or its short code (spring-sale) from another Shlink step or the trigger. Capitals matter.
- Domain
domaintext - The short URL's domain, when it isn't on the server's default domain and is named by its short code alone. Leave blank otherwise.
Outputs
bot_visitsnumber- Visits Shlink thinks came from bots or link previews
created_attext- When it was made (ISO 8601)
domaintext- The domain it's on, such as s.example.com
human_visitsnumber- Visits Shlink doesn't think came from bots
long_urltext- The address it opens
max_visitsnumber- The most visits it takes before it stops; 0 for no limit
short_codetext- The short code at the end of the short link, such as spring-sale
short_urltext- The short link, such as https://s.example.com/spring-sale
tagslist- Its tags, in lower case
titletext- Its title; empty when it has none
valid_sincetext- When it starts working (ISO 8601); empty when it always has
valid_untiltext- When it stops working (ISO 8601); empty when it never does
visitsnumber- How many times it has been visited
Example output
{
"bot_visits": 3,
"created_at": "2026-11-06T10:00:00+00:00",
"domain": "s.example.com",
"human_visits": 39,
"long_url": "https://example.com/spring-sale?utm_source=newsletter",
"max_visits": 0,
"short_code": "spring-sale",
"short_url": "https://s.example.com/spring-sale",
"tags": [
"campaign",
"newsletter"
],
"title": "Spring sale",
"valid_since": "",
"valid_until": "2026-12-31T23:59:59+00:00",
"visits": 42
}Get visits
Count and list the visits to a short URL, a tag's short URLs or every short URL, in a period you choose, with visits per day and the referrers and countries they came from most.
Inputs
- Short URL
short_urltext - The short link or its short code. Leave blank for a tag's or every short URL's visits.
- Domain
domaintext - The domain of a short URL named by its code, or, with no short URL, only visits to this domain's short URLs.
- Tag
tagtext - Only visits to short URLs with this tag, when no short URL is given.
- Since
sincedate and time - Only visits from this time. Leave blank for all.
- Until
untildate and time - Only visits up to this time; a date alone means the end of that day (UTC). Leave blank for now.
- Skip bots
skip_botstrue/false - Leave out visits Shlink thinks came from bots, such as link previews in chat apps and search engines.Default:
false. - How many to list
limitnumber - The most visits to list, newest first. Defaults to 25; the counts cover every visit.From 1 to 100.
Outputs
botsnumber- How many of the visits read look like bots
by_daylist- Visits per day, oldest first
countnumber- How many visits are listed
countednumber- How many visits were read for the counts by day, referrer and country (the newest 5,000 at most)
countrieslist- The countries visits came from most; empty unless the server looks up locations
referrerslist- The sites visitors came from most, with direct for none
totalnumber- How many visits there were in the period
visitslist- The newest visits, newest first
Example output
{
"bots": 3,
"by_day": [
{
"date": "2026-11-06",
"visits": 42
}
],
"count": 1,
"counted": 42,
"countries": [
{
"country": "United Kingdom",
"visits": 25
}
],
"referrers": [
{
"referrer": "news.example.net",
"visits": 30
}
],
"total": 42,
"visits": [
{
"bot": false,
"city": "London",
"country": "United Kingdom",
"country_code": "GB",
"date": "2026-11-06T10:15:00+00:00",
"redirected_to": "https://example.com/spring-sale?utm_source=newsletter",
"referrer": "https://news.example.net/article",
"referrer_site": "news.example.net",
"region": "England",
"user_agent": "Mozilla/5.0 (iPhone; CPU iPhone OS 18_0 like Mac OS X)",
"visited_url": "https://s.example.com/spring-sale"
}
]
}List domains
List the domains short links can be made on, the default one first.
Inputs
None.
Outputs
countnumber- How many are listed
domainslist- The domains
Example output
{
"count": 1,
"domains": [
{
"domain": "s.example.com",
"is_default": true
}
]
}List tags
List every tag, A to Z, with how many short URLs and visits each has.
Inputs
None.
Outputs
countnumber- How many are listed
tagslist- The tags
Example output
{
"count": 1,
"tags": [
{
"human_visits": 401,
"short_urls": 12,
"tag": "campaign",
"visits": 420
}
]
}Shorten a link
Make a short link for a long address, such as a campaign link or a shared document, with your own ending, a title and tags, on the domain you choose, and limits on when and how often it works.
Inputs
- Long URL
long_urltextRequired - The address the short link opens. https:// is added when it has none.
- Custom slug
custom_slugtext - What the short link ends with, such as spring-sale for s.example.com/spring-sale. Spaces become hyphens. Leave blank for a random code.
- Title
titletext - A name for the short URL, shown in Shlink.
- Tags
tagslist - Tags to group it by, such as campaign.
- Domain
domaintext - The domain the short link is on, for a server with more than one. Leave blank for the default domain.
- Valid since
valid_sincedate and time - When the short link starts working. Leave blank for now.
- Valid until
valid_untildate and time - When it stops working. A date alone means the end of that day (UTC). Leave blank for never.
- Most visits
max_visitsnumber - How many visits it takes before it stops working. Leave blank for no limit.At least 1.
- Reuse an existing one
find_if_existstrue/false - Give back the short URL already made for this link with the same slug, tags and limits instead of making another, so a workflow that runs again doesn't pile up short links.Default:
false.
Outputs
bot_visitsnumber- Visits Shlink thinks came from bots or link previews
created_attext- When it was made (ISO 8601)
domaintext- The domain it's on, such as s.example.com
human_visitsnumber- Visits Shlink doesn't think came from bots
long_urltext- The address it opens
max_visitsnumber- The most visits it takes before it stops; 0 for no limit
short_codetext- The short code at the end of the short link, such as spring-sale
short_urltext- The short link, such as https://s.example.com/spring-sale
tagslist- Its tags, in lower case
titletext- Its title; empty when it has none
valid_sincetext- When it starts working (ISO 8601); empty when it always has
valid_untiltext- When it stops working (ISO 8601); empty when it never does
visitsnumber- How many times it has been visited
Example output
{
"bot_visits": 3,
"created_at": "2026-11-06T10:00:00+00:00",
"domain": "s.example.com",
"human_visits": 39,
"long_url": "https://example.com/spring-sale?utm_source=newsletter",
"max_visits": 0,
"short_code": "spring-sale",
"short_url": "https://s.example.com/spring-sale",
"tags": [
"campaign",
"newsletter"
],
"title": "Spring sale",
"valid_since": "",
"valid_until": "2026-12-31T23:59:59+00:00",
"visits": 42
}Update short URL
Change where a short URL goes, its title or tags, or when and how often it works. Fields left blank keep what it has.
Inputs
- Short URL
short_urltextRequired - The short link, such as https://s.example.com/spring-sale, or its short code (spring-sale) from another Shlink step or the trigger. Capitals matter.
- Domain
domaintext - The short URL's domain, when it isn't on the server's default domain and is named by its short code alone. Leave blank otherwise.
- Long URL
long_urltext - A new address for it to open. Leave blank to keep it.
- Title
titletext - A new title. Leave blank to keep it.
- Tags
tagslist - Tags that replace its tags. Leave blank to keep them.
- Add tags
add_tagslist - Tags to add, keeping the ones it has, such as shared.
- Valid since
valid_sincedate and time - A new time for it to start working. Leave blank to keep it.
- Valid until
valid_untildate and time - A new time for it to stop working; a date alone means the end of that day (UTC). Leave blank to keep it.
- Most visits
max_visitsnumber - A new most visits before it stops working. Leave blank to keep it.At least 1.
- Remove limits
remove_limitstrue/false - Clear its Valid since, Valid until and Most visits, so it works again for good. Limits given in this step still apply.Default:
false.
Outputs
bot_visitsnumber- Visits Shlink thinks came from bots or link previews
created_attext- When it was made (ISO 8601)
domaintext- The domain it's on, such as s.example.com
human_visitsnumber- Visits Shlink doesn't think came from bots
long_urltext- The address it opens
max_visitsnumber- The most visits it takes before it stops; 0 for no limit
short_codetext- The short code at the end of the short link, such as spring-sale
short_urltext- The short link, such as https://s.example.com/spring-sale
tagslist- Its tags, in lower case
titletext- Its title; empty when it has none
valid_sincetext- When it starts working (ISO 8601); empty when it always has
valid_untiltext- When it stops working (ISO 8601); empty when it never does
visitsnumber- How many times it has been visited
Example output
{
"bot_visits": 3,
"created_at": "2026-11-06T10:00:00+00:00",
"domain": "s.example.com",
"human_visits": 39,
"long_url": "https://example.com/spring-sale?utm_source=newsletter",
"max_visits": 0,
"short_code": "spring-sale",
"short_url": "https://s.example.com/spring-sale",
"tags": [
"campaign",
"newsletter"
],
"title": "Spring sale",
"valid_since": "",
"valid_until": "2026-12-31T23:59:59+00:00",
"visits": 42
}