get_automation
Retrieve automation workflow details from Mailchimp using a specific workflow ID to access email marketing campaign information.
Instructions
Get details of a specific automation by workflow ID
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| workflow_id | Yes | The workflow ID of the automation |
Implementation Reference
- src/tools/index.ts:569-578 (handler)The handler function for the 'get_automation' tool. It calls the MailchimpService.getAutomation method with the provided workflow_id argument and returns the automation details as a JSON-formatted text response.case "get_automation": const automation = await service.getAutomation(args.workflow_id); return { content: [ { type: "text", text: JSON.stringify(automation, null, 2), }, ], };
- src/tools/index.ts:13-25 (registration)The tool registration definition in getToolDefinitions array, including name, description, and input schema for 'get_automation'.{ name: "get_automation", description: "Get details of a specific automation by workflow ID", inputSchema: { type: "object", properties: { workflow_id: { type: "string", description: "The workflow ID of the automation", }, }, required: ["workflow_id"], },
- src/tools/index.ts:16-24 (schema)The input schema defining the required 'workflow_id' parameter of type string for the 'get_automation' tool.inputSchema: { type: "object", properties: { workflow_id: { type: "string", description: "The workflow ID of the automation", }, }, required: ["workflow_id"],
- src/services/mailchimp.ts:106-108 (helper)The core service method that performs the HTTP request to Mailchimp API endpoint /automations/{workflowId} to fetch the automation details.async getAutomation(workflowId: string): Promise<MailchimpAutomation> { return await this.makeRequest(`/automations/${workflowId}`); }
- src/types/index.ts:3-127 (schema)The TypeScript interface defining the structure of the MailchimpAutomation object returned by the tool.export interface MailchimpAutomation { id: string; name: string; status: "save" | "paused" | "sending"; create_time: string; start_time?: string; from_name: string; from_email: string; subject: string; reply_to: string; to_name: string; title: string; type: | "abandonedCart" | "abandonedBrowse" | "api" | "bestCustomers" | "click" | "date" | "email" | "emailSeries" | "groupAdd" | "groupRemove" | "mandrill" | "product" | "purchase" | "signup" | "signupFollowUp" | "survey" | "visit" | "welcome"; template_id?: number; delay?: number; delay_type?: "now" | "day" | "hour" | "week"; delay_unit?: "day" | "hour" | "week"; delay_value?: number; delay_direction?: "before" | "after"; delay_full?: { delay_type: string; delay_unit: string; delay_value: number; delay_direction: string; }; trigger_settings?: { workflow_type: string; workflow_title?: string; runtime?: { days?: number[]; hours?: number[]; }; one_time?: boolean; one_time_date?: string; }; tracking?: { opens: boolean; html_clicks: boolean; text_clicks: boolean; goal_tracking: boolean; ecomm360: boolean; google_analytics: string; clicktale: string; salesforce?: { campaign: boolean; notes: boolean; }; capsule?: { notes: boolean; }; }; settings?: { title: string; from_name: string; reply_to: string; use_conversation: boolean; to_name: string; folder_id: string; authenticate: boolean; auto_footer: boolean; inline_css: boolean; auto_tweet: boolean; fb_comments: boolean; timewarp: boolean; template_id: number; drag_and_drop: boolean; }; social_card?: { image_url?: string; description?: string; title?: string; }; trigger_settings_workflow_type?: string; trigger_settings_workflow_title?: string; trigger_settings_runtime?: { days?: number[]; hours?: number[]; }; trigger_settings_one_time?: boolean; trigger_settings_one_time_date?: string; report_summary?: { opens: number; unique_opens: number; open_rate: number; clicks: number; subscriber_clicks: number; click_rate: number; visits: number; unique_visits: number; conversion_rate: number; subscribes: number; ecommerce?: { total_revenue: number; currency_code: string; average_order_revenue: number; total_orders: number; total_products_sold: number; }; }; _links?: Array<{ rel: string; href: string; method: string; targetSchema?: string; schema?: string; }>; }