Server definition
- Hash
- sha256:97b6e505b222a9279420037acccc660268df61f9612d7c85690052a09f08f5c6
- What it is
- What a remote MCP server returned when asked what it offers: 25 tools
The blob, as servednamed by its sha256
{
"instructions": "Linkly is a link-management and analytics platform. Use these tools to create, update, search, and delete short links; manage custom domains and favicons; configure click webhooks; and read click analytics and exports for the authenticated user's workspace. All actions run against the current OAuth-authenticated workspace (see list_workspaces). Find a link's id with search_links or list_links before calling get_link, update_link, or delete_link.",
"tools": [
{
"description": "Batch delete multiple links",
"inputSchema": {
"properties": {
"ids": {
"description": "Array of link IDs to delete",
"items": {
"type": "integer"
},
"type": "array"
}
},
"required": [
"ids"
],
"type": "object"
},
"name": "batchDeleteLinks",
"outputSchema": {
"additionalProperties": true,
"type": "object"
}
},
{
"description": "Add a custom domain to the workspace. The domain must be configured to point to Linkly's servers.",
"inputSchema": {
"properties": {
"name": {
"description": "The domain name (e.g., 'links.example.com')",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"name": "create_domain",
"outputSchema": {
"additionalProperties": true,
"description": "A custom domain (mirrors the OpenAPI Domain schema)",
"properties": {
"name": {
"type": [
"string",
"null"
]
},
"workspace_id": {
"type": [
"integer",
"null"
]
}
},
"type": "object"
}
},
{
"description": "Create short links and URL shorteners. Use this when the user asks to shorten a URL, create a short link, or make a link shorter.",
"inputSchema": {
"properties": {
"block_bots": {
"description": "Block known bots and spiders from following the link",
"type": "boolean"
},
"cloaking": {
"description": "Hide destination URL by opening in an iframe",
"type": "boolean"
},
"domain": {
"description": "Custom domain for the short link (without trailing /). Must be a domain that already belongs to this workspace — call list_domains to get valid values. Required whenever slug is set.",
"type": "string"
},
"enabled": {
"description": "Whether the link is active (default: true)",
"type": "boolean"
},
"expiry_datetime": {
"description": "ISO 8601 datetime when the link should expire",
"type": "string"
},
"expiry_destination": {
"description": "Fallback URL after expiry (404 if blank)",
"type": "string"
},
"fb_pixel_id": {
"description": "Meta/Facebook Pixel ID for tracking",
"type": "string"
},
"forward_params": {
"description": "Forward URL parameters to the destination",
"type": "boolean"
},
"ga4_tag_id": {
"description": "Google Analytics 4 tag ID",
"type": "string"
},
"gtm_id": {
"description": "Google Tag Manager container ID",
"type": "string"
},
"hide_referrer": {
"description": "Hide referrer information when users click",
"type": "boolean"
},
"name": {
"description": "A nickname for the link to identify it later",
"type": "string"
},
"note": {
"description": "A private note about this link",
"type": "string"
},
"og_description": {
"description": "Open Graph description for social media previews",
"type": "string"
},
"og_image": {
"description": "Open Graph image URL for social media previews",
"type": "string"
},
"og_title": {
"description": "Open Graph title for social media previews",
"type": "string"
},
"slug": {
"description": "Custom slug/suffix for the link (must start with /). Only valid together with domain: setting slug without a workspace-owned domain is rejected by the API.",
"type": "string"
},
"url": {
"description": "The destination URL for the link (required)",
"type": "string"
},
"utm_campaign": {
"description": "UTM campaign parameter",
"type": "string"
},
"utm_content": {
"description": "UTM content parameter",
"type": "string"
},
"utm_medium": {
"description": "UTM medium parameter",
"type": "string"
},
"utm_source": {
"description": "UTM source parameter",
"type": "string"
},
"utm_term": {
"description": "UTM term parameter",
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
},
"name": "create_link",
"outputSchema": {
"additionalProperties": true,
"description": "A Linkly link (mirrors the OpenAPI Link schema)",
"properties": {
"block_bots": {
"type": [
"boolean",
"null"
]
},
"body_tags": {
"type": [
"string",
"null"
]
},
"cloaking": {
"type": [
"boolean",
"null"
]
},
"created_by_user_id": {
"type": [
"integer",
"null"
]
},
"deleted": {
"type": [
"boolean",
"null"
]
},
"domain": {
"type": [
"string",
"null"
]
},
"enabled": {
"type": [
"boolean",
"null"
]
},
"expiry_clicks": {
"type": [
"integer",
"null"
]
},
"expiry_datetime": {
"type": [
"string",
"null"
]
},
"expiry_destination": {
"format": "uri",
"type": [
"string",
"null"
]
},
"fb_pixel_id": {
"type": [
"string",
"null"
]
},
"forward_params": {
"type": [
"boolean",
"null"
]
},
"full_url": {
"description": "Full short-link URL",
"format": "uri",
"type": [
"string",
"null"
]
},
"ga4_tag_id": {
"type": [
"string",
"null"
]
},
"gtm_id": {
"type": [
"string",
"null"
]
},
"head_tags": {
"type": [
"string",
"null"
]
},
"hide_referrer": {
"type": [
"boolean",
"null"
]
},
"id": {
"description": "Link ID",
"type": [
"integer",
"null"
]
},
"linkedin_partner_id": {
"type": [
"string",
"null"
]
},
"linkify_words": {
"type": [
"string",
"null"
]
},
"microsoft_uet_tag_id": {
"type": [
"string",
"null"
]
},
"name": {
"type": [
"string",
"null"
]
},
"note": {
"type": [
"string",
"null"
]
},
"notify_slack": {
"type": [
"boolean",
"null"
]
},
"notify_user_ids": {
"items": {
"type": "integer"
},
"type": [
"array",
"null"
]
},
"og_description": {
"type": [
"string",
"null"
]
},
"og_image": {
"type": [
"string",
"null"
]
},
"og_title": {
"type": [
"string",
"null"
]
},
"password": {
"type": [
"string",
"null"
]
},
"pinterest_tag_id": {
"type": [
"string",
"null"
]
},
"public_analytics": {
"type": [
"boolean",
"null"
]
},
"qr_styles": {
"additionalProperties": true,
"type": [
"object",
"null"
]
},
"reddit_pixel_id": {
"type": [
"string",
"null"
]
},
"replacements": {
"type": [
"string",
"null"
]
},
"rules": {
"items": {
"additionalProperties": true,
"properties": {
"matches": {
"type": "string"
},
"percentage": {
"type": "string"
},
"rule_url": {
"type": "string"
},
"url": {
"type": "string"
},
"what": {
"type": "string"
}
},
"type": "object"
},
"type": [
"array",
"null"
]
},
"skip_social_crawler_tracking": {
"type": [
"boolean",
"null"
]
},
"slug": {
"type": [
"string",
"null"
]
},
"snapchat_pixel_id": {
"type": [
"string",
"null"
]
},
"tiktok_pixel_id": {
"type": [
"string",
"null"
]
},
"twitter_pixel_id": {
"type": [
"string",
"null"
]
},
"url": {
"description": "Destination URL",
"format": "uri",
"type": [
"string",
"null"
]
},
"utm_campaign": {
"type": [
"string",
"null"
]
},
"utm_content": {
"type": [
"string",
"null"
]
},
"utm_medium": {
"type": [
"string",
"null"
]
},
"utm_source": {
"type": [
"string",
"null"
]
},
"utm_term": {
"type": [
"string",
"null"
]
},
"webhooks": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"workspace_id": {
"type": [
"integer",
"null"
]
}
},
"type": "object"
}
},
{
"description": "Remove a custom domain from the workspace.",
"inputSchema": {
"properties": {
"domain_id": {
"description": "The ID of the domain to delete",
"type": "integer"
}
},
"required": [
"domain_id"
],
"type": "object"
},
"name": "delete_domain",
"outputSchema": {
"additionalProperties": true,
"type": "object"
}
},
{
"description": "Delete a Linkly link by its ID",
"inputSchema": {
"properties": {
"link_id": {
"description": "The ID of the link to delete",
"type": "integer"
}
},
"required": [
"link_id"
],
"type": "object"
},
"name": "delete_link",
"outputSchema": {
"additionalProperties": true,
"type": "object"
}
},
{
"description": "Export detailed click records with full information (timestamp, browser, country, URL, platform, referer, bot, ISP, params).",
"inputSchema": {
"properties": {
"bots": {
"description": "Bot filtering",
"enum": [
"include",
"exclude",
"only"
],
"type": "string"
},
"country": {
"description": "Filter by country code",
"type": "string"
},
"end": {
"description": "End date in YYYY-MM-DD format (default: yesterday)",
"type": "string"
},
"link_id": {
"description": "Filter by specific link ID",
"type": "integer"
},
"platform": {
"description": "Filter by platform",
"type": "string"
},
"start": {
"description": "Start date in YYYY-MM-DD format (default: 30 days ago)",
"type": "string"
}
},
"required": [],
"type": "object"
},
"name": "export_clicks",
"outputSchema": {
"additionalProperties": true,
"description": "Time-series click data",
"properties": {
"results": {
"type": "array"
}
},
"type": "object"
}
},
{
"description": "Get time-series click analytics data for charting. Returns click counts over time.",
"inputSchema": {
"properties": {
"bots": {
"description": "Bot filtering: include (default), exclude, or only",
"enum": [
"include",
"exclude",
"only"
],
"type": "string"
},
"browser": {
"description": "Filter by browser name",
"type": "string"
},
"country": {
"description": "Filter by country code (e.g., 'US', 'GB')",
"type": "string"
},
"end": {
"description": "End date in YYYY-MM-DD format (default: today)",
"type": "string"
},
"frequency": {
"description": "Time granularity: 'day' (default) or 'hour'",
"enum": [
"day",
"hour"
],
"type": "string"
},
"link_id": {
"description": "Filter by specific link ID",
"type": "integer"
},
"platform": {
"description": "Filter by platform (e.g., 'desktop', 'mobile', 'tablet')",
"type": "string"
},
"start": {
"description": "Start date in YYYY-MM-DD format (default: 30 days ago)",
"type": "string"
},
"unique": {
"description": "Count unique clicks only (by IP)",
"type": "boolean"
}
},
"required": [],
"type": "object"
},
"name": "get_analytics",
"outputSchema": {
"additionalProperties": true,
"type": "object"
}
},
{
"description": "Get click counts grouped by a dimension (country, platform, referrer, etc.). Useful for breakdowns and top-N reports.",
"inputSchema": {
"properties": {
"bots": {
"description": "Bot filtering",
"enum": [
"include",
"exclude",
"only"
],
"type": "string"
},
"counter": {
"description": "Dimension to group by (required)",
"enum": [
"country",
"platform",
"referer",
"isp",
"link_id",
"destination",
"bot_name"
],
"type": "string"
},
"country": {
"description": "Filter by country code",
"type": "string"
},
"end": {
"description": "End date in YYYY-MM-DD format (default: today)",
"type": "string"
},
"link_id": {
"description": "Filter by specific link ID",
"type": "integer"
},
"platform": {
"description": "Filter by platform",
"type": "string"
},
"start": {
"description": "Start date in YYYY-MM-DD format (default: 30 days ago)",
"type": "string"
},
"unique": {
"description": "Count unique clicks only",
"type": "boolean"
}
},
"required": [
"counter"
],
"type": "object"
},
"name": "get_analytics_by",
"outputSchema": {
"additionalProperties": true,
"type": "object"
}
},
{
"description": "Get recent click data for the workspace",
"inputSchema": {
"properties": {
"link_id": {
"description": "Optional: filter clicks by link ID",
"type": "integer"
}
},
"required": [],
"type": "object"
},
"name": "get_clicks",
"outputSchema": {
"additionalProperties": true,
"description": "Time-series click data",
"properties": {
"results": {
"type": "array"
}
},
"type": "object"
}
},
{
"description": "Get details of a specific Linkly link by its ID",
"inputSchema": {
"properties": {
"link_id": {
"description": "The ID of the link to retrieve",
"type": "integer"
}
},
"required": [
"link_id"
],
"type": "object"
},
"name": "get_link",
"outputSchema": {
"additionalProperties": true,
"description": "A Linkly link (mirrors the OpenAPI Link schema)",
"properties": {
"block_bots": {
"type": [
"boolean",
"null"
]
},
"body_tags": {
"type": [
"string",
"null"
]
},
"cloaking": {
"type": [
"boolean",
"null"
]
},
"created_by_user_id": {
"type": [
"integer",
"null"
]
},
"deleted": {
"type": [
"boolean",
"null"
]
},
"domain": {
"type": [
"string",
"null"
]
},
"enabled": {
"type": [
"boolean",
"null"
]
},
"expiry_clicks": {
"type": [
"integer",
"null"
]
},
"expiry_datetime": {
"type": [
"string",
"null"
]
},
"expiry_destination": {
"format": "uri",
"type": [
"string",
"null"
]
},
"fb_pixel_id": {
"type": [
"string",
"null"
]
},
"forward_params": {
"type": [
"boolean",
"null"
]
},
"full_url": {
"description": "Full short-link URL",
"format": "uri",
"type": [
"string",
"null"
]
},
"ga4_tag_id": {
"type": [
"string",
"null"
]
},
"gtm_id": {
"type": [
"string",
"null"
]
},
"head_tags": {
"type": [
"string",
"null"
]
},
"hide_referrer": {
"type": [
"boolean",
"null"
]
},
"id": {
"description": "Link ID",
"type": [
"integer",
"null"
]
},
"linkedin_partner_id": {
"type": [
"string",
"null"
]
},
"linkify_words": {
"type": [
"string",
"null"
]
},
"microsoft_uet_tag_id": {
"type": [
"string",
"null"
]
},
"name": {
"type": [
"string",
"null"
]
},
"note": {
"type": [
"string",
"null"
]
},
"notify_slack": {
"type": [
"boolean",
"null"
]
},
"notify_user_ids": {
"items": {
"type": "integer"
},
"type": [
"array",
"null"
]
},
"og_description": {
"type": [
"string",
"null"
]
},
"og_image": {
"type": [
"string",
"null"
]
},
"og_title": {
"type": [
"string",
"null"
]
},
"password": {
"type": [
"string",
"null"
]
},
"pinterest_tag_id": {
"type": [
"string",
"null"
]
},
"public_analytics": {
"type": [
"boolean",
"null"
]
},
"qr_styles": {
"additionalProperties": true,
"type": [
"object",
"null"
]
},
"reddit_pixel_id": {
"type": [
"string",
"null"
]
},
"replacements": {
"type": [
"string",
"null"
]
},
"rules": {
"items": {
"additionalProperties": true,
"properties": {
"matches": {
"type": "string"
},
"percentage": {
"type": "string"
},
"rule_url": {
"type": "string"
},
"url": {
"type": "string"
},
"what": {
"type": "string"
}
},
"type": "object"
},
"type": [
"array",
"null"
]
},
"skip_social_crawler_tracking": {
"type": [
"boolean",
"null"
]
},
"slug": {
"type": [
"string",
"null"
]
},
"snapchat_pixel_id": {
"type": [
"string",
"null"
]
},
"tiktok_pixel_id": {
"type": [
"string",
"null"
]
},
"twitter_pixel_id": {
"type": [
"string",
"null"
]
},
"url": {
"description": "Destination URL",
"format": "uri",
"type": [
"string",
"null"
]
},
"utm_campaign": {
"type": [
"string",
"null"
]
},
"utm_content": {
"type": [
"string",
"null"
]
},
"utm_medium": {
"type": [
"string",
"null"
]
},
"utm_source": {
"type": [
"string",
"null"
]
},
"utm_term": {
"type": [
"string",
"null"
]
},
"webhooks": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"workspace_id": {
"type": [
"integer",
"null"
]
}
},
"type": "object"
}
},
{
"description": "List all custom domains in the workspace.",
"inputSchema": {
"properties": {},
"required": [],
"type": "object"
},
"name": "list_domains",
"outputSchema": {
"additionalProperties": true,
"properties": {
"results": {
"items": {
"additionalProperties": true,
"description": "A custom domain (mirrors the OpenAPI Domain schema)",
"properties": {
"name": {
"type": [
"string",
"null"
]
},
"workspace_id": {
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
},
{
"description": "List all webhook URLs subscribed to a specific link.",
"inputSchema": {
"properties": {
"link_id": {
"description": "The ID of the link",
"type": "integer"
}
},
"required": [
"link_id"
],
"type": "object"
},
"name": "list_link_webhooks",
"outputSchema": {
"additionalProperties": true,
"properties": {
"results": {
"items": {
"format": "uri",
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
},
{
"description": "List links with sorting and search",
"inputSchema": {
"properties": {
"page": {
"type": "integer"
},
"page_size": {
"type": "integer"
},
"search": {
"description": "Search Query",
"type": "string"
},
"sort_by": {
"description": "Field to sort by",
"type": "string"
},
"sort_dir": {
"description": "Sort direction",
"enum": [
"asc",
"desc"
],
"type": "string"
}
},
"required": [],
"type": "object"
},
"name": "list_links",
"outputSchema": {
"additionalProperties": true,
"properties": {
"results": {
"items": {
"additionalProperties": true,
"description": "A Linkly link (mirrors the OpenAPI Link schema)",
"properties": {
"block_bots": {
"type": [
"boolean",
"null"
]
},
"body_tags": {
"type": [
"string",
"null"
]
},
"cloaking": {
"type": [
"boolean",
"null"
]
},
"created_by_user_id": {
"type": [
"integer",
"null"
]
},
"deleted": {
"type": [
"boolean",
"null"
]
},
"domain": {
"type": [
"string",
"null"
]
},
"enabled": {
"type": [
"boolean",
"null"
]
},
"expiry_clicks": {
"type": [
"integer",
"null"
]
},
"expiry_datetime": {
"type": [
"string",
"null"
]
},
"expiry_destination": {
"format": "uri",
"type": [
"string",
"null"
]
},
"fb_pixel_id": {
"type": [
"string",
"null"
]
},
"forward_params": {
"type": [
"boolean",
"null"
]
},
"full_url": {
"description": "Full short-link URL",
"format": "uri",
"type": [
"string",
"null"
]
},
"ga4_tag_id": {
"type": [
"string",
"null"
]
},
"gtm_id": {
"type": [
"string",
"null"
]
},
"head_tags": {
"type": [
"string",
"null"
]
},
"hide_referrer": {
"type": [
"boolean",
"null"
]
},
"id": {
"description": "Link ID",
"type": [
"integer",
"null"
]
},
"linkedin_partner_id": {
"type": [
"string",
"null"
]
},
"linkify_words": {
"type": [
"string",
"null"
]
},
"microsoft_uet_tag_id": {
"type": [
"string",
"null"
]
},
"name": {
"type": [
"string",
"null"
]
},
"note": {
"type": [
"string",
"null"
]
},
"notify_slack": {
"type": [
"boolean",
"null"
]
},
"notify_user_ids": {
"items": {
"type": "integer"
},
"type": [
"array",
"null"
]
},
"og_description": {
"type": [
"string",
"null"
]
},
"og_image": {
"type": [
"string",
"null"
]
},
"og_title": {
"type": [
"string",
"null"
]
},
"password": {
"type": [
"string",
"null"
]
},
"pinterest_tag_id": {
"type": [
"string",
"null"
]
},
"public_analytics": {
"type": [
"boolean",
"null"
]
},
"qr_styles": {
"additionalProperties": true,
"type": [
"object",
"null"
]
},
"reddit_pixel_id": {
"type": [
"string",
"null"
]
},
"replacements": {
"type": [
"string",
"null"
]
},
"rules": {
"items": {
"additionalProperties": true,
"properties": {
"matches": {
"type": "string"
},
"percentage": {
"type": "string"
},
"rule_url": {
"type": "string"
},
"url": {
"type": "string"
},
"what": {
"type": "string"
}
},
"type": "object"
},
"type": [
"array",
"null"
]
},
"skip_social_crawler_tracking": {
"type": [
"boolean",
"null"
]
},
"slug": {
"type": [
"string",
"null"
]
},
"snapchat_pixel_id": {
"type": [
"string",
"null"
]
},
"tiktok_pixel_id": {
"type": [
"string",
"null"
]
},
"twitter_pixel_id": {
"type": [
"string",
"null"
]
},
"url": {
"description": "Destination URL",
"format": "uri",
"type": [
"string",
"null"
]
},
"utm_campaign": {
"type": [
"string",
"null"
]
},
"utm_content": {
"type": [
"string",
"null"
]
},
"utm_medium": {
"type": [
"string",
"null"
]
},
"utm_source": {
"type": [
"string",
"null"
]
},
"utm_term": {
"type": [
"string",
"null"
]
},
"webhooks": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"workspace_id": {
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
},
{
"description": "List all webhook URLs subscribed to the workspace. These receive click events for all links.",
"inputSchema": {
"properties": {},
"required": [],
"type": "object"
},
"name": "list_webhooks",
"outputSchema": {
"additionalProperties": true,
"properties": {
"results": {
"items": {
"format": "uri",
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
},
{
"description": "Return details of authenticated workspace",
"inputSchema": {
"properties": {},
"required": [],
"type": "object"
},
"name": "list_workspaces",
"outputSchema": {
"additionalProperties": true,
"properties": {
"results": {
"items": {
"additionalProperties": true,
"properties": {
"id": {
"description": "Workspace ID",
"type": "integer"
},
"name": {
"description": "Workspace name",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
},
{
"description": "Health check",
"inputSchema": {
"properties": {
"message": {
"description": "a message to ping , default to Hello From Linkkly",
"type": "string"
}
},
"required": [
"message"
],
"type": "object"
},
"name": "ping",
"outputSchema": null
},
{
"description": "Search for links by name, URL, or note. Returns matching links with click statistics.",
"inputSchema": {
"properties": {
"query": {
"description": "Search query to match against link names, URLs, and notes",
"type": "string"
}
},
"required": [
"query"
],
"type": "object"
},
"name": "search_links",
"outputSchema": {
"additionalProperties": true,
"properties": {
"results": {
"items": {
"additionalProperties": true,
"description": "A Linkly link (mirrors the OpenAPI Link schema)",
"properties": {
"block_bots": {
"type": [
"boolean",
"null"
]
},
"body_tags": {
"type": [
"string",
"null"
]
},
"cloaking": {
"type": [
"boolean",
"null"
]
},
"created_by_user_id": {
"type": [
"integer",
"null"
]
},
"deleted": {
"type": [
"boolean",
"null"
]
},
"domain": {
"type": [
"string",
"null"
]
},
"enabled": {
"type": [
"boolean",
"null"
]
},
"expiry_clicks": {
"type": [
"integer",
"null"
]
},
"expiry_datetime": {
"type": [
"string",
"null"
]
},
"expiry_destination": {
"format": "uri",
"type": [
"string",
"null"
]
},
"fb_pixel_id": {
"type": [
"string",
"null"
]
},
"forward_params": {
"type": [
"boolean",
"null"
]
},
"full_url": {
"description": "Full short-link URL",
"format": "uri",
"type": [
"string",
"null"
]
},
"ga4_tag_id": {
"type": [
"string",
"null"
]
},
"gtm_id": {
"type": [
"string",
"null"
]
},
"head_tags": {
"type": [
"string",
"null"
]
},
"hide_referrer": {
"type": [
"boolean",
"null"
]
},
"id": {
"description": "Link ID",
"type": [
"integer",
"null"
]
},
"linkedin_partner_id": {
"type": [
"string",
"null"
]
},
"linkify_words": {
"type": [
"string",
"null"
]
},
"microsoft_uet_tag_id": {
"type": [
"string",
"null"
]
},
"name": {
"type": [
"string",
"null"
]
},
"note": {
"type": [
"string",
"null"
]
},
"notify_slack": {
"type": [
"boolean",
"null"
]
},
"notify_user_ids": {
"items": {
"type": "integer"
},
"type": [
"array",
"null"
]
},
"og_description": {
"type": [
"string",
"null"
]
},
"og_image": {
"type": [
"string",
"null"
]
},
"og_title": {
"type": [
"string",
"null"
]
},
"password": {
"type": [
"string",
"null"
]
},
"pinterest_tag_id": {
"type": [
"string",
"null"
]
},
"public_analytics": {
"type": [
"boolean",
"null"
]
},
"qr_styles": {
"additionalProperties": true,
"type": [
"object",
"null"
]
},
"reddit_pixel_id": {
"type": [
"string",
"null"
]
},
"replacements": {
"type": [
"string",
"null"
]
},
"rules": {
"items": {
"additionalProperties": true,
"properties": {
"matches": {
"type": "string"
},
"percentage": {
"type": "string"
},
"rule_url": {
"type": "string"
},
"url": {
"type": "string"
},
"what": {
"type": "string"
}
},
"type": "object"
},
"type": [
"array",
"null"
]
},
"skip_social_crawler_tracking": {
"type": [
"boolean",
"null"
]
},
"slug": {
"type": [
"string",
"null"
]
},
"snapchat_pixel_id": {
"type": [
"string",
"null"
]
},
"tiktok_pixel_id": {
"type": [
"string",
"null"
]
},
"twitter_pixel_id": {
"type": [
"string",
"null"
]
},
"url": {
"description": "Destination URL",
"format": "uri",
"type": [
"string",
"null"
]
},
"utm_campaign": {
"type": [
"string",
"null"
]
},
"utm_content": {
"type": [
"string",
"null"
]
},
"utm_medium": {
"type": [
"string",
"null"
]
},
"utm_source": {
"type": [
"string",
"null"
]
},
"utm_term": {
"type": [
"string",
"null"
]
},
"webhooks": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"workspace_id": {
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
},
{
"description": "Subscribe a webhook URL to receive click events for a specific link.",
"inputSchema": {
"properties": {
"link_id": {
"description": "The ID of the link",
"type": "integer"
},
"url": {
"description": "The webhook URL to receive click event notifications",
"type": "string"
}
},
"required": [
"link_id",
"url"
],
"type": "object"
},
"name": "subscribe_link_webhook",
"outputSchema": {
"additionalProperties": true,
"type": "object"
}
},
{
"description": "Subscribe a webhook URL to receive click events for all links in the workspace.",
"inputSchema": {
"properties": {
"url": {
"description": "The webhook URL to receive click event notifications",
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
},
"name": "subscribe_webhook",
"outputSchema": {
"additionalProperties": true,
"type": "object"
}
},
{
"description": "Test API Authentication",
"inputSchema": {
"properties": {},
"required": [],
"type": "object"
},
"name": "test_authentication",
"outputSchema": {
"additionalProperties": true,
"type": "object"
}
},
{
"description": "Unsubscribe a webhook URL from a specific link's click events.",
"inputSchema": {
"properties": {
"link_id": {
"description": "The ID of the link",
"type": "integer"
},
"url": {
"description": "The webhook URL to unsubscribe",
"type": "string"
}
},
"required": [
"link_id",
"url"
],
"type": "object"
},
"name": "unsubscribe_link_webhook",
"outputSchema": null
},
{
"description": "Unsubscribe a webhook URL from workspace click events.",
"inputSchema": {
"properties": {
"url": {
"description": "The webhook URL to unsubscribe",
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
},
"name": "unsubscribe_webhook",
"outputSchema": null
},
{
"description": "Update the favicon URL for a custom domain.",
"inputSchema": {
"properties": {
"domain_id": {
"description": "The ID of the domain to update",
"type": "integer"
},
"favicon_url": {
"description": "URL to the favicon image",
"type": "string"
}
},
"required": [
"domain_id",
"favicon_url"
],
"type": "object"
},
"name": "update_domain_favicon",
"outputSchema": {
"additionalProperties": true,
"type": "object"
}
},
{
"description": "Update an existing Linkly link by its ID",
"inputSchema": {
"properties": {
"block_bots": {
"description": "Block bots",
"type": "boolean"
},
"cloaking": {
"description": "Enable URL cloaking",
"type": "boolean"
},
"enabled": {
"description": "Whether the link is active",
"type": "boolean"
},
"expiry_datetime": {
"description": "Expiry datetime (ISO 8601)",
"type": "string"
},
"expiry_destination": {
"description": "Fallback URL after expiry",
"type": "string"
},
"fb_pixel_id": {
"description": "Meta Pixel ID",
"type": "string"
},
"forward_params": {
"description": "Forward URL parameters",
"type": "boolean"
},
"ga4_tag_id": {
"description": "Google Analytics 4 tag ID",
"type": "string"
},
"gtm_id": {
"description": "Google Tag Manager ID",
"type": "string"
},
"hide_referrer": {
"description": "Hide referrer",
"type": "boolean"
},
"link_id": {
"description": "The ID of the link to update (required)",
"type": "integer"
},
"name": {
"description": "New nickname for the link",
"type": "string"
},
"note": {
"description": "New private note",
"type": "string"
},
"og_description": {
"description": "Open Graph description",
"type": "string"
},
"og_image": {
"description": "Open Graph image URL",
"type": "string"
},
"og_title": {
"description": "Open Graph title",
"type": "string"
},
"url": {
"description": "New destination URL",
"type": "string"
},
"utm_campaign": {
"description": "UTM campaign parameter",
"type": "string"
},
"utm_content": {
"description": "UTM content parameter",
"type": "string"
},
"utm_medium": {
"description": "UTM medium parameter",
"type": "string"
},
"utm_source": {
"description": "UTM source parameter",
"type": "string"
},
"utm_term": {
"description": "UTM term parameter",
"type": "string"
}
},
"required": [
"link_id"
],
"type": "object"
},
"name": "update_link",
"outputSchema": {
"additionalProperties": true,
"description": "A Linkly link (mirrors the OpenAPI Link schema)",
"properties": {
"block_bots": {
"type": [
"boolean",
"null"
]
},
"body_tags": {
"type": [
"string",
"null"
]
},
"cloaking": {
"type": [
"boolean",
"null"
]
},
"created_by_user_id": {
"type": [
"integer",
"null"
]
},
"deleted": {
"type": [
"boolean",
"null"
]
},
"domain": {
"type": [
"string",
"null"
]
},
"enabled": {
"type": [
"boolean",
"null"
]
},
"expiry_clicks": {
"type": [
"integer",
"null"
]
},
"expiry_datetime": {
"type": [
"string",
"null"
]
},
"expiry_destination": {
"format": "uri",
"type": [
"string",
"null"
]
},
"fb_pixel_id": {
"type": [
"string",
"null"
]
},
"forward_params": {
"type": [
"boolean",
"null"
]
},
"full_url": {
"description": "Full short-link URL",
"format": "uri",
"type": [
"string",
"null"
]
},
"ga4_tag_id": {
"type": [
"string",
"null"
]
},
"gtm_id": {
"type": [
"string",
"null"
]
},
"head_tags": {
"type": [
"string",
"null"
]
},
"hide_referrer": {
"type": [
"boolean",
"null"
]
},
"id": {
"description": "Link ID",
"type": [
"integer",
"null"
]
},
"linkedin_partner_id": {
"type": [
"string",
"null"
]
},
"linkify_words": {
"type": [
"string",
"null"
]
},
"microsoft_uet_tag_id": {
"type": [
"string",
"null"
]
},
"name": {
"type": [
"string",
"null"
]
},
"note": {
"type": [
"string",
"null"
]
},
"notify_slack": {
"type": [
"boolean",
"null"
]
},
"notify_user_ids": {
"items": {
"type": "integer"
},
"type": [
"array",
"null"
]
},
"og_description": {
"type": [
"string",
"null"
]
},
"og_image": {
"type": [
"string",
"null"
]
},
"og_title": {
"type": [
"string",
"null"
]
},
"password": {
"type": [
"string",
"null"
]
},
"pinterest_tag_id": {
"type": [
"string",
"null"
]
},
"public_analytics": {
"type": [
"boolean",
"null"
]
},
"qr_styles": {
"additionalProperties": true,
"type": [
"object",
"null"
]
},
"reddit_pixel_id": {
"type": [
"string",
"null"
]
},
"replacements": {
"type": [
"string",
"null"
]
},
"rules": {
"items": {
"additionalProperties": true,
"properties": {
"matches": {
"type": "string"
},
"percentage": {
"type": "string"
},
"rule_url": {
"type": "string"
},
"url": {
"type": "string"
},
"what": {
"type": "string"
}
},
"type": "object"
},
"type": [
"array",
"null"
]
},
"skip_social_crawler_tracking": {
"type": [
"boolean",
"null"
]
},
"slug": {
"type": [
"string",
"null"
]
},
"snapchat_pixel_id": {
"type": [
"string",
"null"
]
},
"tiktok_pixel_id": {
"type": [
"string",
"null"
]
},
"twitter_pixel_id": {
"type": [
"string",
"null"
]
},
"url": {
"description": "Destination URL",
"format": "uri",
"type": [
"string",
"null"
]
},
"utm_campaign": {
"type": [
"string",
"null"
]
},
"utm_content": {
"type": [
"string",
"null"
]
},
"utm_medium": {
"type": [
"string",
"null"
]
},
"utm_source": {
"type": [
"string",
"null"
]
},
"utm_term": {
"type": [
"string",
"null"
]
},
"webhooks": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"workspace_id": {
"type": [
"integer",
"null"
]
}
},
"type": "object"
}
},
{
"description": "Update workspace settings. Only the fields provided are changed; omitted fields keep their current values.",
"inputSchema": {
"properties": {
"name": {
"description": "Workspace name",
"type": "string"
},
"webhooks": {
"description": "REPLACES the workspace's full webhook subscription list. Omit to leave webhooks unchanged; prefer subscribe_webhook / unsubscribe_webhook for adding or removing a single URL.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [],
"type": "object"
},
"name": "update_workspace",
"outputSchema": {
"additionalProperties": true,
"type": "object"
}
}
]
}Verify it yourself
curl -s https://api.teppi.xyz/v1/evidence/sha256:97b6e505b222a9279420037acccc660268df61f9612d7c85690052a09f08f5c6 | sha256sum