Linkly

linkly

Linkly is a URL shortener and click-tracking platform for branded short links, UTM tagging, retargeting pixels, link rotators, QR codes, and click analytics. To create an API key, sign in to Linkly at linklyhq.com and go to Settings → API Keys.

URL Shortener Marketing Automation Web del proveedor

Acciones

Triggers

Autenticación

—

OAuth gestionado

Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (17)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Create or Update LinkLINKLY_CREATE_OR_UPDATE_LINKAcción

Tool to create a new shortened link or update an existing one in Linkly. Use when you need to generate a trackable short URL with custom parameters, UTM tracking, retargeting pixels, or Open Graph metadata. To create a new link, provide url and workspace_id. To update an existing link, provide id and the fields you want to change.

Parámetros de entrada

idinteger
Link ID. Required to update an existing link, omit when creating new
urlstring
Destination URL. Required when creating a new link, optional when updating
namestring
Nickname/label for the link for easy identification
slugstring
Custom slug for the shortened URL (must start with /). If not provided, a random slug is generated
rulesobject[]
Array of conditional redirect rules for advanced routing (device-based, geo-based, A/B testing, etc.)
domainstring
Custom domain for the shortened link (without trailing /). Must be configured in your workspace
gtm_idstring
Google Tag Manager container ID (format: GTM-XXXXXXX)
enabledboolean
Whether the link is active and will redirect. Set to false to disable the link temporarily
cloakingboolean
Enable link cloaking to mask the destination URL in browser
og_imagestring
Open Graph image URL displayed when the link is shared on social media
og_titlestring
Open Graph title displayed when the link is shared on social media
utm_termstring
UTM term parameter for paid search keywords
block_botsboolean
Block known bot traffic from accessing the link
ga4_tag_idstring
Google Analytics 4 measurement ID for tracking (format: G-XXXXXXXXXX)
utm_mediumstring
UTM medium parameter for campaign tracking (e.g., email, social, cpc)
utm_sourcestring
UTM source parameter for campaign tracking (e.g., newsletter, twitter)
fb_pixel_idstring
Facebook Pixel ID for retargeting and conversion tracking
utm_contentstring
UTM content parameter for A/B testing and content-targeted ads
utm_campaignstring
UTM campaign parameter for tracking campaign name
workspace_idinteger
Workspace ID. Required when creating a new link, optional when updating
hide_referrerboolean
Hide HTTP referrer information from the destination website
forward_paramsboolean
Forward query parameters from the short link to the destination URL
og_descriptionstring
Open Graph description displayed when the link is shared on social media

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete LinkLINKLY_DELETE_LINKAcción

Tool to delete a specific link by ID from a workspace. Use when you need to permanently remove a link. This action is permanent and cannot be undone.

Parámetros de entrada

idintegerObligatorio
The id of the Link to delete
workspace_idstringObligatorio
The id of the Workspace

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete LinksLINKLY_DELETE_LINKSAcción

Tool to delete one or more links by their IDs. This action is permanent and cannot be undone. Use when you need to remove links from a workspace.

Parámetros de entrada

idsinteger[]Obligatorio
List of link IDs to delete. This operation is permanent and cannot be undone.
workspace_idstringObligatorio
The ID of the workspace containing the links to delete

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Export LinksLINKLY_EXPORT_LINKSAcción

Tool to export all links in a workspace as JSON or CSV. Use when you need to retrieve all links for backup, analysis, or migration purposes.

Parámetros de entrada

formatstringenum
Export format - either json or csv
jsoncsv
searchstring
Search query to filter links
workspace_idstringObligatorio
The id of the Workspace

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Click Counters by DimensionLINKLY_GET_CLICK_COUNTERSAcción

Tool to retrieve click analytics grouped by a specific dimension (counter). Returns aggregated counts for each unique value of the selected dimension. Use when you need to analyze click patterns by country, platform, browser, referrer, ISP, link, or URL parameters.

Parámetros de entrada

endstring
The end date for the date range in YYYY-MM-DD format
botsboolean
Set to false to exclude bot clicks from the results. Default includes bots.
startstring
The start date for the date range in YYYY-MM-DD format
formatstringenum
Format of the response data.
jsoncsvtsv
uniqueboolean
Set to true to only count unique clicks (one per IP/user). Default counts all clicks.
counterstringObligatorioenum
The dimension to group clicks by. Options: country, platform, browser, referer, isp, link_id, or top_params
countryplatformbrowserrefererisplink_idtop_params
countrystring
Filter by country using ISO 3166-1 alpha-2 country code (e.g., US, GB, DE)
link_idstring
The ID of a single Link to filter by
link_idsstring
Comma-separated list of Link IDs to filter by
workspace_idstringObligatorio
The ID of the Workspace

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Click AnalyticsLINKLY_GET_CLICKSAcción

Tool to retrieve click analytics for a workspace. Filter by link, date range, country, and more. Returns time-series data suitable for charting.

Parámetros de entrada

endstring
End date for the date range filter. Accepts formats: YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ.
ispstring
Filter clicks by Internet Service Provider name.
botsboolean
Set to false to exclude bot clicks from the results. Default behavior includes bots.
pivotstringenum
Pivot option for the response data.
link_id
startstring
Start date for the date range filter. Accepts formats: YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ.
formatstringenum
Format for the API response.
jsoncsvtsv
uniqueboolean
Set to true to only include unique clicks in the results. Default is false.
browserstring
Filter clicks by browser name (e.g., 'Chrome', 'Firefox', 'Safari').
countrystring
Filter clicks by country using ISO 3166-1 alpha-2 country code (e.g., 'US', 'GB', 'CA').
link_idstring
Filter clicks by a single link ID.
refererstring
Filter clicks by referrer domain.
link_idsstring
Filter clicks by multiple links. Provide a comma-separated list of link IDs (e.g., '24,25,26').
platformstring
Filter clicks by platform/operating system (e.g., 'Windows', 'Mac', 'iOS', 'Android').
timezonestring
The timezone to use for date/time calculations (e.g., 'America/New_York', 'Europe/London').
frequencystringenum
Frequency of data points in the response.
dayhour
workspace_idstringObligatorio
The ID of the workspace to retrieve click analytics for.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Link DetailsLINKLY_GET_LINKAcción

Tool to retrieve detailed information about a specific link by its ID. Use when you need to fetch link configuration, UTM parameters, or click statistics.

Parámetros de entrada

idstringObligatorio
The id of the Link
workspace_idstring
Workspace ID. Optional when using OAuth2 Bearer token.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Link By IDLINKLY_GET_LINK_BY_IDAcción

Tool to retrieve details for a specific link by ID. Use when you need to fetch information about a shortened link, including its destination URL, click statistics, and configuration settings.

Parámetros de entrada

idintegerObligatorio
The unique identifier of the link to retrieve.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List DomainsLINKLY_LIST_DOMAINSAcción

Tool to retrieve all custom domains configured for a workspace. Use when you need to see available domains for creating short links.

Parámetros de entrada

workspace_idstringObligatorio
The ID of the workspace to retrieve domains for.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List LinksLINKLY_LIST_LINKSAcción

Tool to get a paginated list of all links in a workspace. Supports search, sorting, and pagination. Returns link details including click statistics. Use when you need to retrieve or search through links.

Parámetros de entrada

pageinteger
Page number for pagination (default: 1)
searchstring
The search query to filter links by name or URL
sort_bystring
Field to sort by (e.g., name, clicks_total, created_at)
sort_dirstring
Sort direction: asc (ascending) or desc (descending)
page_sizeinteger
Number of links to return per page (default: 1000)
workspace_idstringObligatorio
The id of the Workspace

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Link WebhooksLINKLY_LIST_LINK_WEBHOOKSAcción

Tool to retrieve all webhook subscriptions for a specific link. Use when you need to see what webhooks are configured for a link.

Parámetros de entrada

link_idintegerObligatorio
The ID of the link to retrieve webhook subscriptions for

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List WorkspacesLINKLY_LIST_WORKSPACESAcción

Tool to retrieve all workspaces the authenticated user has access to. Use this to discover available workspace IDs for other API calls.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List workspace webhooksLINKLY_LIST_WORKSPACE_WEBHOOKSAcción

Tool to list all webhook subscriptions for a specific workspace. Use when you need to retrieve or view the configured webhooks for a workspace.

Parámetros de entrada

workspace_idintegerObligatorio
The ID of the workspace to list webhooks for

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Subscribe webhook to linkLINKLY_SUBSCRIBE_WEBHOOK_TO_LINKAcción

Tool to subscribe a webhook URL to receive notifications when a specific link is clicked. Use when you need to track click events for a shortened link.

Parámetros de entrada

urlstringObligatorio
The webhook URL that will receive POST requests when the link is clicked. The webhook will receive click data including country, platform, browser, and more.
link_idintegerObligatorio
The ID of the link to subscribe the webhook to. This is the unique identifier for the shortened link.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Subscribe Webhook to WorkspaceLINKLY_SUBSCRIBE_WEBHOOK_TO_WORKSPACEAcción

Tool to subscribe a webhook URL to receive click notifications from a Linkly workspace. Use when you need to set up real-time notifications for link clicks. The webhook will receive POST requests containing click data including country, platform, browser, and other analytics information whenever any link in the workspace is clicked.

Parámetros de entrada

urlstringObligatorio
The webhook URL that will receive POST requests with click data. Must be a valid HTTP/HTTPS URL that can accept POST requests with JSON payloads containing click information (country, platform, browser, etc.).
workspace_idintegerObligatorio
The ID of the workspace to subscribe the webhook to. This workspace will send click notifications to the specified webhook URL.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Unsubscribe Webhook from LinkLINKLY_UNSUBSCRIBE_WEBHOOK_FROM_LINKAcción

Tool to remove a webhook subscription from a link. Use when you need to stop receiving webhook events for a specific link.

Parámetros de entrada

hook_idstringObligatorio
The webhook URL (will be URL-encoded automatically if not already encoded). This is the URL that was subscribed to receive webhook events.
link_idintegerObligatorio
The ID of the link to remove the webhook subscription from.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Unsubscribe Webhook From WorkspaceLINKLY_UNSUBSCRIBE_WEBHOOK_FROM_WORKSPACEAcción

Tool to remove a webhook subscription from a workspace. Use when you need to unsubscribe a webhook URL from receiving events for a specific workspace.

Parámetros de entrada

hook_idstringObligatorio
The webhook URL (must be URL-encoded). This is the encoded version of the webhook URL you want to unsubscribe.
workspace_idintegerObligatorio
The ID of the workspace from which to unsubscribe the webhook.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not