list_webhooks
Retrieve all configured webhooks from ShipStation to monitor order updates, shipment notifications, and other events automatically.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "list_webhooks"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Implementation Reference
- src/tools/webhook-tools.js:9-21 (handler)The handler function for the 'list_webhooks' tool. Fetches all webhooks using shipStationClient.getWebhooks() and returns them as formatted JSON string, or an error message if failed.
handler: async () => { try { const webhooks = await shipStationClient.getWebhooks(); return { content: [{ type: "text", text: JSON.stringify(webhooks, null, 2) }] }; } catch (error) { return { content: [{ type: "text", text: error.message }], isError: true }; } } - src/tools/webhook-tools.js:8-8 (schema)Input schema for 'list_webhooks' tool, which is empty indicating no parameters are required.
schema: {}, - src/server.js:174-191 (registration)Registration of all ShipStation tools, including 'list_webhooks' from webhookTools, using the MCP server's tool() method.
[ ...orderTools, ...shipmentTools, ...carrierTools, ...warehouseTools, ...productTools, ...customerTools, ...storeTools, ...webhookTools, ...fulfillmentTools ].forEach(tool => { server.tool( tool.name, tool.schema, tool.handler, { description: tool.description } ); }); - src/tools/webhook-tools.js:5-22 (registration)Local registration of the 'list_webhooks' tool within the webhookTools array that is exported and later used for server registration.
{ name: "list_webhooks", description: "List all webhooks for the account", schema: {}, handler: async () => { try { const webhooks = await shipStationClient.getWebhooks(); return { content: [{ type: "text", text: JSON.stringify(webhooks, null, 2) }] }; } catch (error) { return { content: [{ type: "text", text: error.message }], isError: true }; } } },