/**
* GoHighLevel Links (Trigger Links) Tools
* Tools for managing trigger links and link tracking
*/
import { GHLApiClient } from '../clients/ghl-api-client.js';
export class LinksTools {
constructor(private ghlClient: GHLApiClient) {}
getToolDefinitions() {
return [
{
name: 'get_links',
description: 'Get all trigger links for a location. Trigger links are trackable URLs that can trigger automations.',
inputSchema: {
type: 'object',
properties: {
locationId: {
type: 'string',
description: 'Location ID (uses default if not provided)'
},
skip: {
type: 'number',
description: 'Number of records to skip for pagination'
},
limit: {
type: 'number',
description: 'Maximum number of links to return'
}
}
}
},
{
name: 'get_link',
description: 'Get a specific trigger link by ID',
inputSchema: {
type: 'object',
properties: {
linkId: {
type: 'string',
description: 'The link ID to retrieve'
},
locationId: {
type: 'string',
description: 'Location ID (uses default if not provided)'
}
},
required: ['linkId']
}
},
{
name: 'create_link',
description: 'Create a new trigger link',
inputSchema: {
type: 'object',
properties: {
locationId: {
type: 'string',
description: 'Location ID (uses default if not provided)'
},
name: {
type: 'string',
description: 'Link name for identification'
},
redirectTo: {
type: 'string',
description: 'Target URL to redirect to when clicked'
},
fieldKey: {
type: 'string',
description: 'Custom field key to update on click'
},
fieldValue: {
type: 'string',
description: 'Value to set for the custom field'
}
},
required: ['name', 'redirectTo']
}
},
{
name: 'update_link',
description: 'Update an existing trigger link',
inputSchema: {
type: 'object',
properties: {
linkId: {
type: 'string',
description: 'The link ID to update'
},
locationId: {
type: 'string',
description: 'Location ID (uses default if not provided)'
},
name: {
type: 'string',
description: 'Link name for identification'
},
redirectTo: {
type: 'string',
description: 'Target URL to redirect to when clicked'
},
fieldKey: {
type: 'string',
description: 'Custom field key to update on click'
},
fieldValue: {
type: 'string',
description: 'Value to set for the custom field'
}
},
required: ['linkId']
}
},
{
name: 'delete_link',
description: 'Delete a trigger link',
inputSchema: {
type: 'object',
properties: {
linkId: {
type: 'string',
description: 'The link ID to delete'
},
locationId: {
type: 'string',
description: 'Location ID (uses default if not provided)'
}
},
required: ['linkId']
}
}
];
}
async handleToolCall(toolName: string, args: Record<string, unknown>): Promise<unknown> {
const config = this.ghlClient.getConfig();
const locationId = (args.locationId as string) || config.locationId;
switch (toolName) {
case 'get_links': {
const params = new URLSearchParams();
params.append('locationId', locationId);
if (args.skip) params.append('skip', String(args.skip));
if (args.limit) params.append('limit', String(args.limit));
return this.ghlClient.makeRequest('GET', `/links/?${params.toString()}`);
}
case 'get_link': {
const linkId = args.linkId as string;
return this.ghlClient.makeRequest('GET', `/links/${linkId}?locationId=${locationId}`);
}
case 'create_link': {
const body: Record<string, unknown> = {
locationId,
name: args.name,
redirectTo: args.redirectTo
};
if (args.fieldKey) body.fieldKey = args.fieldKey;
if (args.fieldValue) body.fieldValue = args.fieldValue;
return this.ghlClient.makeRequest('POST', `/links/`, body);
}
case 'update_link': {
const linkId = args.linkId as string;
const body: Record<string, unknown> = { locationId };
if (args.name) body.name = args.name;
if (args.redirectTo) body.redirectTo = args.redirectTo;
if (args.fieldKey) body.fieldKey = args.fieldKey;
if (args.fieldValue) body.fieldValue = args.fieldValue;
return this.ghlClient.makeRequest('PUT', `/links/${linkId}`, body);
}
case 'delete_link': {
const linkId = args.linkId as string;
return this.ghlClient.makeRequest('DELETE', `/links/${linkId}?locationId=${locationId}`);
}
default:
throw new Error(`Unknown tool: ${toolName}`);
}
}
}
