create_webhook
Set up webhook notifications for ShipBob API events like order.created or shipment.created to receive automated updates at your specified URL.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | The URL to send webhook notifications to | |
| eventType | Yes | Event type to subscribe to (e.g., 'order.created', 'shipment.created') | |
| isActive | No | Whether the webhook is active |
Implementation Reference
- src/tools/webhook-tools.js:34-54 (handler)The main handler function for the create_webhook tool. It processes the input parameters, calls the ShipBob API client to create the webhook, and returns a formatted response or error message.handler: async ({ url, eventType, isActive = true }) => { try { const webhookData = { url, eventType, isActive }; const newWebhook = await shipbobClient.createWebhook(webhookData); return { content: [{ type: "text", text: `Webhook created successfully: ${JSON.stringify(newWebhook, null, 2)}` }] }; } catch (error) { return { content: [{ type: "text", text: `Error creating webhook: ${error.message}` }], isError: true }; } }
- src/tools/webhook-tools.js:29-33 (schema)Zod schema defining the input parameters for the create_webhook tool: required URL (validated as URL), eventType (string), and optional isActive (boolean).schema: { url: z.string().url().describe("The URL to send webhook notifications to"), eventType: z.string().describe("Event type to subscribe to (e.g., 'order.created', 'shipment.created')"), isActive: z.boolean().optional().describe("Whether the webhook is active") },
- src/server.js:54-54 (registration)Registers the webhookTools array, which includes the create_webhook tool, with the MCP server using the registerTools utility function.registerTools(webhookTools);
- src/api-client.js:123-125 (helper)Helper method in the ShipBobClient class that makes the actual API POST request to create a webhook.async createWebhook(webhookData) { return this.request('POST', '/webhooks', webhookData); }
- src/tools/webhook-tools.js:26-55 (registration)The tool definition object within the webhookTools array, including name, description, schema, and handler for create_webhook.{ name: "create_webhook", description: "Create a new webhook in ShipBob", schema: { url: z.string().url().describe("The URL to send webhook notifications to"), eventType: z.string().describe("Event type to subscribe to (e.g., 'order.created', 'shipment.created')"), isActive: z.boolean().optional().describe("Whether the webhook is active") }, handler: async ({ url, eventType, isActive = true }) => { try { const webhookData = { url, eventType, isActive }; const newWebhook = await shipbobClient.createWebhook(webhookData); return { content: [{ type: "text", text: `Webhook created successfully: ${JSON.stringify(newWebhook, null, 2)}` }] }; } catch (error) { return { content: [{ type: "text", text: `Error creating webhook: ${error.message}` }], isError: true }; } } },