Skip to content
Try for free
On this page

Integrations

Dub

Link management with Dub

Use Dub to create and manage short links with custom domains, slugs, UTM parameters, and link-preview titles and descriptions. Upsert Link creates or updates a link by destination URL; lookup and deletion also support the identifiers documented for each action.

List actions support filtering, sorting, and pagination. Analytics report clicks, leads, and sales, with grouping by time, geography, device, browser, referrer, and other supported dimensions.

Use the block

Create, update, delete, or list short links with custom domains, slugs, link-preview titles and descriptions, and UTM parameters. Retrieve click, lead, and sales analytics.

Actions

Dub Create Link

Create a new short link with Dub. Supports custom domains, slugs, UTM parameters, and more.

Inputs and outputs

Input

ParameterTypeRequiredDescription
apiKeystringYesDub API key
urlstringYesThe destination URL of the short link
domainstringNoCustom domain for the short link (defaults to dub.sh)
keystringNoCustom slug for the short link (randomly generated if not provided)
externalIdstringNoExternal ID for the link in your database
tenantIdstringNoTenant ID for grouping links created on behalf of a customer/tenant
folderIdstringNoFolder ID to organize the link into
trackConversionbooleanNoWhether to track conversions (leads/sales) for the short link
tagIdsstringNoComma-separated tag IDs to assign to the link
commentsstringNoComments for the short link
expiresAtstringNoExpiration date in ISO 8601 format
passwordstringNoPassword to protect the short link
rewritebooleanNoWhether to enable link cloaking
archivedbooleanNoWhether to archive the link
titlestringNoCustom OG title for the link preview
descriptionstringNoCustom OG description for the link preview
utm_sourcestringNoUTM source parameter
utm_mediumstringNoUTM medium parameter
utm_campaignstringNoUTM campaign parameter
utm_termstringNoUTM term parameter
utm_contentstringNoUTM content parameter

Output

ParameterTypeDescription
idstringUnique ID of the created link
domainstringDomain of the short link
keystringSlug of the short link
urlstringDestination URL
shortLinkstringFull short link URL
qrCodestringQR code URL for the short link
archivedbooleanWhether the link is archived
externalIdstringExternal ID
titlestringOG title
descriptionstringOG description
tagsjsonTags assigned to the link (id, name, color)
folderIdstringFolder the link is organized into
tenantIdstringTenant ID associated with the link
trackConversionbooleanWhether conversion tracking is enabled
clicksnumberNumber of clicks
leadsnumberNumber of leads
conversionsnumberNumber of conversions
salesnumberNumber of sales
saleAmountnumberTotal sale amount in cents
lastClickedstringLast clicked timestamp
createdAtstringCreation timestamp
updatedAtstringLast update timestamp
utm_sourcestringUTM source parameter
utm_mediumstringUTM medium parameter
utm_campaignstringUTM campaign parameter
utm_termstringUTM term parameter
utm_contentstringUTM content parameter

Dub Upsert Link

Create or update a short link by its URL. If a link with the same URL already exists, update it. Otherwise, create a new link.

Inputs and outputs

Input

ParameterTypeRequiredDescription
apiKeystringYesDub API key
urlstringYesThe destination URL of the short link
domainstringNoCustom domain for the short link (defaults to dub.sh)
keystringNoCustom slug for the short link (randomly generated if not provided)
externalIdstringNoExternal ID for the link in your database
tenantIdstringNoTenant ID for grouping links created on behalf of a customer/tenant
folderIdstringNoFolder ID to organize the link into
trackConversionbooleanNoWhether to track conversions (leads/sales) for the short link
tagIdsstringNoComma-separated tag IDs to assign to the link
commentsstringNoComments for the short link
expiresAtstringNoExpiration date in ISO 8601 format
passwordstringNoPassword to protect the short link
rewritebooleanNoWhether to enable link cloaking
archivedbooleanNoWhether to archive the link
titlestringNoCustom OG title for the link preview
descriptionstringNoCustom OG description for the link preview
utm_sourcestringNoUTM source parameter
utm_mediumstringNoUTM medium parameter
utm_campaignstringNoUTM campaign parameter
utm_termstringNoUTM term parameter
utm_contentstringNoUTM content parameter

Output

ParameterTypeDescription
idstringUnique ID of the link
domainstringDomain of the short link
keystringSlug of the short link
urlstringDestination URL
shortLinkstringFull short link URL
qrCodestringQR code URL for the short link
archivedbooleanWhether the link is archived
externalIdstringExternal ID
titlestringOG title
descriptionstringOG description
tagsjsonTags assigned to the link (id, name, color)
folderIdstringFolder the link is organized into
tenantIdstringTenant ID associated with the link
trackConversionbooleanWhether conversion tracking is enabled
clicksnumberNumber of clicks
leadsnumberNumber of leads
conversionsnumberNumber of conversions
salesnumberNumber of sales
saleAmountnumberTotal sale amount in cents
lastClickedstringLast clicked timestamp
createdAtstringCreation timestamp
updatedAtstringLast update timestamp
utm_sourcestringUTM source parameter
utm_mediumstringUTM medium parameter
utm_campaignstringUTM campaign parameter
utm_termstringUTM term parameter
utm_contentstringUTM content parameter

Dub Get Link

Retrieve information about a short link by its link ID, external ID, or domain + key combination.

Inputs and outputs

Input

ParameterTypeRequiredDescription
apiKeystringYesDub API key
linkIdstringNoThe unique ID of the short link
externalIdstringNoThe external ID of the link in your database
domainstringNoThe domain of the link (use with key)
keystringNoThe slug of the link (use with domain)

Output

ParameterTypeDescription
idstringUnique ID of the link
domainstringDomain of the short link
keystringSlug of the short link
urlstringDestination URL
shortLinkstringFull short link URL
qrCodestringQR code URL for the short link
archivedbooleanWhether the link is archived
externalIdstringExternal ID
titlestringOG title
descriptionstringOG description
tagsjsonTags assigned to the link (id, name, color)
folderIdstringFolder the link is organized into
tenantIdstringTenant ID associated with the link
trackConversionbooleanWhether conversion tracking is enabled
clicksnumberNumber of clicks
leadsnumberNumber of leads
conversionsnumberNumber of conversions
salesnumberNumber of sales
saleAmountnumberTotal sale amount in cents
lastClickedstringLast clicked timestamp
createdAtstringCreation timestamp
updatedAtstringLast update timestamp
utm_sourcestringUTM source parameter
utm_mediumstringUTM medium parameter
utm_campaignstringUTM campaign parameter
utm_termstringUTM term parameter
utm_contentstringUTM content parameter

Dub Update Link

Update an existing short link's destination URL, domain, slug, link-preview title and description, UTM parameters, and other supported settings.

Inputs and outputs

Input

ParameterTypeRequiredDescription
apiKeystringYesDub API key
linkIdstringYesThe link ID or external ID prefixed with ext_
urlstringNoNew destination URL
domainstringNoNew custom domain
keystringNoNew custom slug
titlestringNoCustom OG title
descriptionstringNoCustom OG description
externalIdstringNoExternal ID for the link
tenantIdstringNoTenant ID for grouping links created on behalf of a customer/tenant
folderIdstringNoFolder ID to organize the link into
trackConversionbooleanNoWhether to track conversions (leads/sales) for the short link
tagIdsstringNoComma-separated tag IDs
commentsstringNoComments for the short link
expiresAtstringNoExpiration date in ISO 8601 format
passwordstringNoPassword to protect the link
rewritebooleanNoWhether to enable link cloaking
archivedbooleanNoWhether to archive the link
utm_sourcestringNoUTM source parameter
utm_mediumstringNoUTM medium parameter
utm_campaignstringNoUTM campaign parameter
utm_termstringNoUTM term parameter
utm_contentstringNoUTM content parameter

Output

ParameterTypeDescription
idstringUnique ID of the updated link
domainstringDomain of the short link
keystringSlug of the short link
urlstringDestination URL
shortLinkstringFull short link URL
qrCodestringQR code URL for the short link
archivedbooleanWhether the link is archived
externalIdstringExternal ID
titlestringOG title
descriptionstringOG description
tagsjsonTags assigned to the link (id, name, color)
folderIdstringFolder the link is organized into
tenantIdstringTenant ID associated with the link
trackConversionbooleanWhether conversion tracking is enabled
clicksnumberNumber of clicks
leadsnumberNumber of leads
conversionsnumberNumber of conversions
salesnumberNumber of sales
saleAmountnumberTotal sale amount in cents
lastClickedstringLast clicked timestamp
createdAtstringCreation timestamp
updatedAtstringLast update timestamp
utm_sourcestringUTM source parameter
utm_mediumstringUTM medium parameter
utm_campaignstringUTM campaign parameter
utm_termstringUTM term parameter
utm_contentstringUTM content parameter

Dub Delete Link

Delete a short link by its link ID or external ID (prefixed with ext_).

Inputs and outputs

Input

ParameterTypeRequiredDescription
apiKeystringYesDub API key
linkIdstringYesThe link ID or external ID prefixed with ext_

Output

ParameterTypeDescription
idstringID of the deleted link

Dub List Links

Retrieve a paginated list of short links for the authenticated workspace. Supports filtering by domain, search query, tags, and sorting.

Inputs and outputs

Input

ParameterTypeRequiredDescription
apiKeystringYesDub API key
domainstringNoFilter by domain
searchstringNoSearch query matched against the short link slug and destination URL
tagIdsstringNoComma-separated tag IDs to filter by
tenantIdstringNoFilter by tenant ID
folderIdstringNoFilter by folder ID
showArchivedbooleanNoWhether to include archived links (defaults to false)
pagenumberNoPage number (deprecated by Dub in favor of startingAfter/endingBefore)
pageSizenumberNoNumber of links per page (default: 100, max: 100)
startingAfterstringNoCursor: fetch results after this link ID
endingBeforestringNoCursor: fetch results before this link ID

Output

ParameterTypeDescription
linksjsonArray of link objects (id, domain, key, url, shortLink, clicks, tags, createdAt)
countnumberNumber of links returned

Dub Count Links

Retrieve the number of short links for the authenticated workspace, optionally filtered and grouped by domain, tag, user, or folder.

Inputs and outputs

Input

ParameterTypeRequiredDescription
apiKeystringYesDub API key
domainstringNoFilter by domain
searchstringNoSearch query matched against the short link slug and destination URL
tagIdsstringNoComma-separated tag IDs to filter by
tagNamesstringNoComma-separated tag names to filter by (case-insensitive)
folderIdstringNoFilter by folder ID
showArchivedbooleanNoWhether to include archived links (defaults to false)
groupBystringNoGroup counts by: domain, tagId, userId, or folderId

Output

ParameterTypeDescription
countnumberTotal number of links matching the filters
groupsjsonPer-group counts when groupBy is set (e.g. [{ domain, count }])

Dub Bulk Create Links

Create up to 100 short links in a single request. Returns the created links alongside any per-link errors.

Inputs and outputs

Input

ParameterTypeRequiredDescription
apiKeystringYesDub API key
linksjsonYesJSON array of link objects to create. Each object requires a "url" and may include domain, key, tagIds, and other link fields (max 100).

Output

ParameterTypeDescription
createdjsonArray of successfully created link objects
errorsjsonArray of per-link errors ({ link, error, code }) for links that failed
countnumberNumber of links successfully created

Dub Bulk Update Links

Apply the same set of field updates to up to 100 links at once, selected by link IDs or external IDs.

Inputs and outputs

Input

ParameterTypeRequiredDescription
apiKeystringYesDub API key
linkIdsstringNoComma-separated link IDs to update (max 100, takes precedence over externalIds)
externalIdsstringNoComma-separated external IDs to update (max 100)
datajsonYesJSON object of fields to apply to every selected link (e.g. { "archived": true, "tagIds": ["..."] })

Output

ParameterTypeDescription
updatedjsonArray of updated link objects
countnumberNumber of links updated

Dub Bulk Delete Links

Delete up to 100 short links in a single request by their link IDs. Non-existing IDs are ignored.

Inputs and outputs

Input

ParameterTypeRequiredDescription
apiKeystringYesDub API key
linkIdsstringYesComma-separated link IDs to delete (max 100)

Output

ParameterTypeDescription
deletedCountnumberNumber of links that were deleted

Dub Get Analytics

Retrieve analytics for links including clicks, leads, and sales. Supports filtering by link, time range, and grouping by various dimensions.

Inputs and outputs

Input

ParameterTypeRequiredDescription
apiKeystringYesDub API key
eventstringNoEvent type: clicks (default), leads, sales, or composite
groupBystringNoGroup results by: count (default), timeseries, countries, cities, devices, browsers, os, referers, top_links, top_urls
linkIdstringNoFilter by link ID
externalIdstringNoFilter by external ID (prefix with ext_)
domainstringNoFilter by domain
intervalstringNoTime interval: 24h (default), 7d, 30d, 90d, 1y, mtd, qtd, ytd, or all
startstringNoStart date/time in ISO 8601 format (overrides interval)
endstringNoEnd date/time in ISO 8601 format (defaults to now)
countrystringNoFilter by country (ISO 3166-1 alpha-2 code)
timezonestringNoIANA timezone for timeseries data (defaults to UTC)

Output

ParameterTypeDescription
clicksnumberTotal number of clicks
leadsnumberTotal number of leads
salesnumberTotal number of sales
saleAmountnumberTotal sale amount in cents
datajsonGrouped analytics data (timeseries, countries, devices, etc.)

Dub List Events

Retrieve a paginated stream of individual click, lead, and sale events for links, with filtering by link, time range, and location.

Inputs and outputs

Input

ParameterTypeRequiredDescription
apiKeystringYesDub API key
eventstringNoEvent type: clicks (default), leads, or sales
linkIdstringNoFilter by link ID
externalIdstringNoFilter by external ID (prefix with ext_)
domainstringNoFilter by domain
intervalstringNoTime interval: 24h (default), 7d, 30d, 90d, 1y, mtd, qtd, ytd, or all
startstringNoStart date/time in ISO 8601 format (overrides interval)
endstringNoEnd date/time in ISO 8601 format (defaults to now)
countrystringNoFilter by country (ISO 3166-1 alpha-2 code)
timezonestringNoIANA timezone for event timestamps (defaults to UTC)
pagenumberNoPage number (default: 1)
limitnumberNoNumber of events per page (default: 100, max: 1000)
sortOrderstringNoSort order: desc (default) or asc

Output

ParameterTypeDescription
eventsjsonArray of event objects (event, timestamp, click, link, and customer/sale data when applicable)
countnumberNumber of events returned

Dub Get QR Code

Generate a customizable QR code (PNG) for a short link, with control over size, error correction, colors, and margin.

Inputs and outputs

Input

ParameterTypeRequiredDescription
apiKeystringYesDub API key
urlstringYesThe short link URL to encode in the QR code
logostringNoURL of a custom logo to embed in the QR code (requires a paid Dub plan)
sizenumberNoQR code size in pixels (default: 600)
levelstringNoError correction level: L (default), M, Q, or H
fgColorstringNoForeground color in hex (default: #000000)
bgColorstringNoBackground color in hex (default: #FFFFFF)
hideLogobooleanNoWhether to hide the logo in the center of the QR code (default: false)
marginnumberNoMargin (quiet zone) around the QR code (default: 2)

Output

ParameterTypeDescription
filefileGenerated QR code image stored in execution files

Dub List Domains

Retrieve the custom domains registered in the workspace, so links can be created against the right domain.

Inputs and outputs

Input

ParameterTypeRequiredDescription
apiKeystringYesDub API key
archivedbooleanNoWhether to include archived domains (defaults to false)
searchstringNoSearch by domain name
pagenumberNoPage number (default: 1)
pageSizenumberNoNumber of domains per page (default: 50, max: 50)

Output

ParameterTypeDescription
domainsjsonArray of domain objects (slug, verified, primary, archived)
countnumberNumber of domains returned

Dub List Tags

Retrieve the tags defined in the workspace, so the right tag IDs can be assigned to links.

Inputs and outputs

Input

ParameterTypeRequiredDescription
apiKeystringYesDub API key
searchstringNoSearch by tag name
sortBystringNoField to sort by: name (default) or createdAt
sortOrderstringNoSort order: asc (default) or desc
pagenumberNoPage number (default: 1)
pageSizenumberNoNumber of tags per page (default: 100, max: 100)

Output

ParameterTypeDescription
tagsjsonArray of tag objects (id, name, color)
countnumberNumber of tags returned

Dub Create Tag

Create a new tag in the workspace for organizing and filtering short links.

Inputs and outputs

Input

ParameterTypeRequiredDescription
apiKeystringYesDub API key
namestringYesThe name of the tag to create (1-50 characters)
colorstringNoTag color: red, yellow, green, blue, purple, brown, gray, or pink (random if omitted)

Output

ParameterTypeDescription
idstringUnique ID of the created tag
namestringName of the tag
colorstringColor assigned to the tag

Dub List Folders

Retrieve the folders defined in the workspace, so the right folder ID can be used to organize links.

Inputs and outputs

Input

ParameterTypeRequiredDescription
apiKeystringYesDub API key
searchstringNoSearch by folder name
pagenumberNoPage number (default: 1)
pageSizenumberNoNumber of folders per page (default: 50, max: 50)

Output

ParameterTypeDescription
foldersjsonArray of folder objects (id, name, accessLevel)
countnumberNumber of folders returned
Was this helpful?
Suggest an edit