list_webhooks
Retrieve and manage webhook configurations from the ShipStation API MCP Server, enabling streamlined integration and automated updates for order and shipment tracking.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {},
"type": "object"
}
Implementation Reference
- src/tools/webhook-tools.js:9-21 (handler)The handler function that implements the list_webhooks tool. It calls shipStationClient.getWebhooks() to fetch all webhooks and returns a formatted JSON response or an error message.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)Empty Zod schema indicating the tool requires no input parameters.schema: {},
- src/server.js:174-191 (registration)Registration of the list_webhooks tool (included in webhookTools) to the MCP server using server.tool() in a loop over all tools.[ ...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)Tool object definition for list_webhooks, exported as part of webhookTools array.{ 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 }; } } },