NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Linkly connects to a Nagent workspace with an API key. Once it is connected, agents can call 17 Linkly actions, such as "Create or Update Link", "Get Click Counters by Dimension" and "Get Click Analytics". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against Linkly, with input parameters and output schema.
LINKLY_CREATE_OR_UPDATE_LINKTool 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.
Input parameters
Link ID. Required to update an existing link, omit when creating new
Destination URL. Required when creating a new link, optional when updating
Nickname/label for the link for easy identification
Custom slug for the shortened URL (must start with /). If not provided, a random slug is generated
Array of conditional redirect rules for advanced routing (device-based, geo-based, A/B testing, etc.)
Custom domain for the shortened link (without trailing /). Must be configured in your workspace
Google Tag Manager container ID (format: GTM-XXXXXXX)
Whether the link is active and will redirect. Set to false to disable the link temporarily
Enable link cloaking to mask the destination URL in browser
Open Graph image URL displayed when the link is shared on social media
Open Graph title displayed when the link is shared on social media
UTM term parameter for paid search keywords
Block known bot traffic from accessing the link
Google Analytics 4 measurement ID for tracking (format: G-XXXXXXXXXX)
UTM medium parameter for campaign tracking (e.g., email, social, cpc)
UTM source parameter for campaign tracking (e.g., newsletter, twitter)
Facebook Pixel ID for retargeting and conversion tracking
UTM content parameter for A/B testing and content-targeted ads
UTM campaign parameter for tracking campaign name
Workspace ID. Required when creating a new link, optional when updating
Hide HTTP referrer information from the destination website
Forward query parameters from the short link to the destination URL
Open Graph description displayed when the link is shared on social media
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
LINKLY_DELETE_LINKTool 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.
Input parameters
The id of the Link to delete
The id of the Workspace
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
LINKLY_DELETE_LINKSTool 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.
Input parameters
List of link IDs to delete. This operation is permanent and cannot be undone.
The ID of the workspace containing the links to delete
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
LINKLY_EXPORT_LINKSTool 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.
Input parameters
Export format - either json or csv
Search query to filter links
The id of the Workspace
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
LINKLY_GET_CLICK_COUNTERSTool 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.
Input parameters
The end date for the date range in YYYY-MM-DD format
Set to false to exclude bot clicks from the results. Default includes bots.
The start date for the date range in YYYY-MM-DD format
Format of the response data.
Set to true to only count unique clicks (one per IP/user). Default counts all clicks.
The dimension to group clicks by. Options: country, platform, browser, referer, isp, link_id, or top_params
Filter by country using ISO 3166-1 alpha-2 country code (e.g., US, GB, DE)
The ID of a single Link to filter by
Comma-separated list of Link IDs to filter by
The ID of the Workspace
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
LINKLY_GET_CLICKSTool to retrieve click analytics for a workspace. Filter by link, date range, country, and more. Returns time-series data suitable for charting.
Input parameters
End date for the date range filter. Accepts formats: YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ.
Filter clicks by Internet Service Provider name.
Set to false to exclude bot clicks from the results. Default behavior includes bots.
Pivot option for the response data.
Start date for the date range filter. Accepts formats: YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ.
Format for the API response.
Set to true to only include unique clicks in the results. Default is false.
Filter clicks by browser name (e.g., 'Chrome', 'Firefox', 'Safari').
Filter clicks by country using ISO 3166-1 alpha-2 country code (e.g., 'US', 'GB', 'CA').
Filter clicks by a single link ID.
Filter clicks by referrer domain.
Filter clicks by multiple links. Provide a comma-separated list of link IDs (e.g., '24,25,26').
Filter clicks by platform/operating system (e.g., 'Windows', 'Mac', 'iOS', 'Android').
The timezone to use for date/time calculations (e.g., 'America/New_York', 'Europe/London').
Frequency of data points in the response.
The ID of the workspace to retrieve click analytics for.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
LINKLY_GET_LINKTool to retrieve detailed information about a specific link by its ID. Use when you need to fetch link configuration, UTM parameters, or click statistics.
Input parameters
The id of the Link
Workspace ID. Optional when using OAuth2 Bearer token.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
LINKLY_GET_LINK_BY_IDTool 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.
Input parameters
The unique identifier of the link to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
LINKLY_LIST_DOMAINSTool to retrieve all custom domains configured for a workspace. Use when you need to see available domains for creating short links.
Input parameters
Page number for pagination (default: 1).
Number of domains to return per page (default: 1000).
The ID of the workspace to retrieve domains for.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
LINKLY_LIST_LINKSTool 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.
Input parameters
Page number for pagination (default: 1)
The search query to filter links by name or URL
Field to sort by (e.g., name, clicks_total, created_at)
Sort direction: asc (ascending) or desc (descending)
Number of links to return per page (default: 1000)
The id of the Workspace
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
LINKLY_LIST_LINK_WEBHOOKSTool to retrieve all webhook subscriptions for a specific link. Use when you need to see what webhooks are configured for a link.
Input parameters
The ID of the link to retrieve webhook subscriptions for
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
LINKLY_LIST_WORKSPACESTool to retrieve all workspaces the authenticated user has access to. Use this to discover available workspace IDs for other API calls.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
LINKLY_LIST_WORKSPACE_WEBHOOKSTool to list all webhook subscriptions for a specific workspace. Use when you need to retrieve or view the configured webhooks for a workspace.
Input parameters
The ID of the workspace to list webhooks for
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
LINKLY_SUBSCRIBE_WEBHOOK_TO_LINKTool 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.
Input parameters
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.
The ID of the link to subscribe the webhook to. This is the unique identifier for the shortened link.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
LINKLY_SUBSCRIBE_WEBHOOK_TO_WORKSPACETool 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.
Input parameters
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.).
The ID of the workspace to subscribe the webhook to. This workspace will send click notifications to the specified webhook URL.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
LINKLY_UNSUBSCRIBE_WEBHOOK_FROM_LINKTool to remove a webhook subscription from a link. Use when you need to stop receiving webhook events for a specific link.
Input parameters
The webhook URL (will be URL-encoded automatically if not already encoded). This is the URL that was subscribed to receive webhook events.
The ID of the link to remove the webhook subscription from.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
LINKLY_UNSUBSCRIBE_WEBHOOK_FROM_WORKSPACETool to remove a webhook subscription from a workspace. Use when you need to unsubscribe a webhook URL from receiving events for a specific workspace.
Input parameters
The webhook URL to unsubscribe. Provide the raw webhook URL (e.g., from the list webhooks endpoint). URL encoding is handled automatically.
The ID of the workspace from which to unsubscribe the webhook.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 17 Linkly actions on Nagent, including "Create or Update Link", "Get Click Counters by Dimension" and "Get Click Analytics". Create or Update Link: Create a new shortened link or update an existing one in Linkly. Each action is listed on this page with its input parameters and its output.
Linkly connects with an API key, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
It also takes 23 optional inputs: id, url, name, slug, rules, domain, gtm_id, enabled, cloaking, og_image, og_title, utm_term, block_bots, ga4_tag_id, utm_medium, utm_source, fb_pixel_id, utm_content, utm_campaign, workspace_id, hide_referrer, forward_params and og_description. It returns data, error and successful.