Help Scout

Help Scout MCP Server for Cloudflare Workers

Available Tools

43 tools available in the Help Scout MCP server. Each tool can be called by AI assistants to perform specific actions.

helpscout_list_conversations

List conversations from Help Scout with filtering and pagination.

Returns a paginated list of conversations. By default only active conversations are returned.

Args:

mailbox: Filter by mailbox ID
folder: Filter by folder ID
status: Filter by status (active, pending, closed, spam, open, all)
tag: Filter by tag name(s), comma-separated
assignedTo: Filter by assigned user ID
modifiedSince: ISO 8601 date to filter by modification date
sortField: Sort by field (createdAt, customerEmail, status, subject)
sortOrder: Sort direction (asc, desc)
query: Advanced search query
page: Page number (1-indexed)
format: Response format (json or markdown)

{
  "type": "object",
  "properties": {
    "tag": {
      "type": "string",
      "description": "Filter by tag name(s), comma-separated"
    },
    "page": {
      "type": "integer",
      "default": 1,
      "minimum": 1,
      "description": "Page number"
    },
    "query": {
      "type": "string",
      "description": "Advanced search query"
    },
    "folder": {
      "type": "number",
      "description": "Filter by folder ID"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "json",
      "description": "Response format"
    },
    "mailbox": {
      "type": "number",
      "description": "Filter by mailbox ID"
    },
    "sortOrder": {
      "enum": [
        "asc",
        "desc"
      ],
      "type": "string",
      "description": "Sort direction"
    },
    "assignedTo": {
      "type": "number",
      "description": "Filter by assigned user ID"
    },
    "modifiedSince": {
      "type": "string",
      "description": "ISO 8601 date"
    }
  }
}

helpscout_get_conversation

Get a single conversation by ID with its threads.

Args:

conversationId: The conversation ID
format: Response format (json or markdown)

Returns the conversation with all threads embedded.

{
  "type": "object",
  "required": [
    "conversationId"
  ],
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "conversationId": {
      "type": "number",
      "description": "Conversation ID"
    }
  }
}

helpscout_create_conversation

Create a new conversation in Help Scout.

Args:

mailboxId: ID of the mailbox to create in (required)
subject: Conversation subject (required)
type: Conversation type - email, chat, or phone (required)
status: Initial status - active, pending, or closed (required)
customerEmail: Customer's email address (required)
customerFirstName: Customer's first name
customerLastName: Customer's last name
customerId: Existing customer ID (alternative to email)
text: Initial message text (required)
threadType: Type of initial thread - customer or reply
assignTo: User ID to assign the conversation to
tags: Comma-separated list of tags

Returns the created conversation ID and location.

{
  "type": "object",
  "required": [
    "mailboxId",
    "subject",
    "type",
    "status",
    "text"
  ],
  "properties": {
    "tags": {
      "type": "string",
      "description": "Comma-separated tags"
    },
    "text": {
      "type": "string",
      "description": "Initial message text"
    },
    "type": {
      "enum": [
        "email",
        "chat",
        "phone"
      ],
      "type": "string",
      "description": "Conversation type"
    },
    "status": {
      "enum": [
        "active",
        "pending",
        "closed"
      ],
      "type": "string",
      "description": "Initial status"
    },
    "subject": {
      "type": "string",
      "description": "Conversation subject"
    },
    "assignTo": {
      "type": "number",
      "description": "User ID to assign to"
    },
    "mailboxId": {
      "type": "number",
      "description": "Mailbox ID"
    },
    "customerId": {
      "type": "number",
      "description": "Existing customer ID"
    },
    "threadType": {
      "enum": [
        "customer",
        "reply"
      ],
      "type": "string",
      "default": "customer",
      "description": "Initial thread type"
    },
    "customerEmail": {
      "type": "string",
      "description": "Customer email"
    },
    "customerLastName": {
      "type": "string",
      "description": "Customer last name"
    },
    "customerFirstName": {
      "type": "string",
      "description": "Customer first name"
    }
  }
}

helpscout_update_conversation

Update a conversation's properties.

Supported operations:

Change subject: path=/subject, value=new subject
Change status: path=/status, value=active|pending|closed
Assign to user: path=/assignTo, value=user ID
Unassign: path=/assignTo (with op=remove)
Change mailbox: path=/mailboxId (with op=move), value=new mailbox ID
Change customer: path=/primaryCustomer.id, value=customer ID

Args:

conversationId: The conversation ID
op: Operation type (replace, remove, or move)
path: Field path to update
value: New value (not needed for remove)

{
  "type": "object",
  "required": [
    "conversationId",
    "op",
    "path"
  ],
  "properties": {
    "op": {
      "enum": [
        "replace",
        "remove",
        "move"
      ],
      "type": "string",
      "description": "Operation type"
    },
    "path": {
      "type": "string",
      "description": "Field path"
    },
    "value": {
      "type": "string",
      "description": "New value"
    },
    "conversationId": {
      "type": "number",
      "description": "Conversation ID"
    }
  }
}

helpscout_delete_conversation

Delete a conversation.

Args:

conversationId: The conversation ID to delete

{
  "type": "object",
  "required": [
    "conversationId"
  ],
  "properties": {
    "conversationId": {
      "type": "number",
      "description": "Conversation ID"
    }
  }
}

helpscout_list_threads

List all threads in a conversation.

Args:

conversationId: The conversation ID
page: Page number (1-indexed)
format: Response format (json or markdown)

{
  "type": "object",
  "required": [
    "conversationId"
  ],
  "properties": {
    "page": {
      "type": "integer",
      "default": 1,
      "minimum": 1,
      "description": "Page number"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "conversationId": {
      "type": "number",
      "description": "Conversation ID"
    }
  }
}

helpscout_create_reply

Send a reply to a conversation.

Args:

conversationId: The conversation ID
customerId: The customer ID (required)
text: Reply text content (required)
draft: Create as draft instead of sending
status: Set conversation status after reply (active, pending, closed)
assignTo: Assign to user ID after reply

{
  "type": "object",
  "required": [
    "conversationId",
    "customerId",
    "text"
  ],
  "properties": {
    "text": {
      "type": "string",
      "description": "Reply text"
    },
    "draft": {
      "type": "boolean",
      "default": false,
      "description": "Create as draft"
    },
    "status": {
      "enum": [
        "active",
        "pending",
        "closed"
      ],
      "type": "string",
      "description": "New status"
    },
    "assignTo": {
      "type": "number",
      "description": "Assign to user ID"
    },
    "customerId": {
      "type": "number",
      "description": "Customer ID"
    },
    "conversationId": {
      "type": "number",
      "description": "Conversation ID"
    }
  }
}

helpscout_create_note

Add an internal note to a conversation (not visible to customer).

Args:

conversationId: The conversation ID
text: Note text content (required)
status: Optionally change conversation status

{
  "type": "object",
  "required": [
    "conversationId",
    "text"
  ],
  "properties": {
    "text": {
      "type": "string",
      "description": "Note text"
    },
    "status": {
      "enum": [
        "active",
        "pending",
        "closed"
      ],
      "type": "string",
      "description": "New status"
    },
    "conversationId": {
      "type": "number",
      "description": "Conversation ID"
    }
  }
}

helpscout_create_customer_thread

Add a customer message to a conversation (simulates customer reply).

Args:

conversationId: The conversation ID
text: Message text (required)
customerEmail: Customer email (or use customerId)
customerId: Customer ID (or use customerEmail)
imported: Mark as imported (won't trigger notifications)

{
  "type": "object",
  "required": [
    "conversationId",
    "text"
  ],
  "properties": {
    "text": {
      "type": "string",
      "description": "Message text"
    },
    "imported": {
      "type": "boolean",
      "default": false,
      "description": "Mark as imported"
    },
    "customerId": {
      "type": "number",
      "description": "Customer ID"
    },
    "customerEmail": {
      "type": "string",
      "description": "Customer email"
    },
    "conversationId": {
      "type": "number",
      "description": "Conversation ID"
    }
  }
}

helpscout_list_customers

List customers from Help Scout with filtering and pagination.

Args:

mailbox: Filter by mailbox ID
firstName: Filter by first name
lastName: Filter by last name
email: Filter by exact email match
modifiedSince: ISO 8601 date to filter by modification date
sortField: Sort by field (createdAt, firstName, lastName, modifiedAt)
sortOrder: Sort direction (asc, desc)
query: Advanced search query
page: Page number (1-indexed)
format: Response format (json or markdown)

{
  "type": "object",
  "properties": {
    "page": {
      "type": "integer",
      "default": 1,
      "minimum": 1,
      "description": "Page number"
    },
    "email": {
      "type": "string",
      "description": "Filter by exact email"
    },
    "query": {
      "type": "string",
      "description": "Advanced search query"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "json",
      "description": "Response format"
    },
    "mailbox": {
      "type": "number",
      "description": "Filter by mailbox ID"
    },
    "lastName": {
      "type": "string",
      "description": "Filter by last name"
    },
    "firstName": {
      "type": "string",
      "description": "Filter by first name"
    },
    "sortOrder": {
      "enum": [
        "asc",
        "desc"
      ],
      "type": "string",
      "description": "Sort direction"
    },
    "modifiedSince": {
      "type": "string",
      "description": "ISO 8601 date"
    }
  }
}

helpscout_get_customer

Get a single customer by ID with all details.

Args:

customerId: The customer ID
format: Response format (json or markdown)

Returns the customer with emails, phones, addresses, social profiles, etc.

{
  "type": "object",
  "required": [
    "customerId"
  ],
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "customerId": {
      "type": "number",
      "description": "Customer ID"
    }
  }
}

helpscout_create_customer

Create a new customer in Help Scout.

Args:

email: Primary email address (required)
emailType: Email type (home, work, other)
firstName: First name
lastName: Last name
phone: Phone number
phoneType: Phone type (home, work, mobile, fax, pager, other)
jobTitle: Job title
organization: Organization/company name
organizationId: Link to existing organization
location: Location string
background: Background notes
gender: Gender (male, female, unknown)

Returns the created customer ID.

{
  "type": "object",
  "required": [
    "email"
  ],
  "properties": {
    "email": {
      "type": "string",
      "description": "Primary email address"
    },
    "phone": {
      "type": "string",
      "description": "Phone number"
    },
    "gender": {
      "enum": [
        "male",
        "female",
        "unknown"
      ],
      "type": "string",
      "description": "Gender"
    },
    "jobTitle": {
      "type": "string",
      "description": "Job title"
    },
    "lastName": {
      "type": "string",
      "description": "Last name"
    },
    "location": {
      "type": "string",
      "description": "Location"
    },
    "emailType": {
      "enum": [
        "home",
        "work",
        "other"
      ],
      "type": "string",
      "default": "work",
      "description": "Email type"
    },
    "firstName": {
      "type": "string",
      "description": "First name"
    },
    "background": {
      "type": "string",
      "description": "Background notes"
    },
    "organization": {
      "type": "string",
      "description": "Organization name"
    },
    "organizationId": {
      "type": "number",
      "description": "Organization ID"
    }
  }
}

helpscout_update_customer

Update a customer's properties using JSON Patch operations.

Common operations:

Update first name: op=replace, path=/firstName, value=NewName
Update last name: op=replace, path=/lastName, value=NewName
Update job title: op=replace, path=/jobTitle, value=NewTitle
Add email: op=add, path=/emails, value={"type":"work","value":"new@example.com"}
Remove specific email: op=remove, path=/emails/123 (use email ID)

Args:

customerId: The customer ID
op: Operation type (add, replace, remove)
path: Field path to update
value: New value (JSON string for complex values)

{
  "type": "object",
  "required": [
    "customerId",
    "op",
    "path"
  ],
  "properties": {
    "op": {
      "enum": [
        "add",
        "replace",
        "remove"
      ],
      "type": "string",
      "description": "Operation type"
    },
    "path": {
      "type": "string",
      "description": "Field path"
    },
    "value": {
      "type": "string",
      "description": "New value (JSON for complex values)"
    },
    "customerId": {
      "type": "number",
      "description": "Customer ID"
    }
  }
}

helpscout_delete_customer

Delete a customer from Help Scout.

Args:

customerId: The customer ID to delete

{
  "type": "object",
  "required": [
    "customerId"
  ],
  "properties": {
    "customerId": {
      "type": "number",
      "description": "Customer ID"
    }
  }
}

helpscout_list_mailboxes

List all mailboxes (inboxes) in Help Scout.

Args:

page: Page number (1-indexed)
format: Response format (json or markdown)

Returns mailbox details including ID, name, email, and slug.

{
  "type": "object",
  "properties": {
    "page": {
      "type": "integer",
      "default": 1,
      "minimum": 1,
      "description": "Page number"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "json",
      "description": "Response format"
    }
  }
}

helpscout_get_mailbox

Get a single mailbox by ID.

Args:

mailboxId: The mailbox ID
format: Response format (json or markdown)

{
  "type": "object",
  "required": [
    "mailboxId"
  ],
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "mailboxId": {
      "type": "number",
      "description": "Mailbox ID"
    }
  }
}

helpscout_list_mailbox_folders

List all folders in a mailbox.

Args:

mailboxId: The mailbox ID
page: Page number (1-indexed)
format: Response format (json or markdown)

Returns folder details including conversation counts.

{
  "type": "object",
  "required": [
    "mailboxId"
  ],
  "properties": {
    "page": {
      "type": "integer",
      "default": 1,
      "minimum": 1,
      "description": "Page number"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "mailboxId": {
      "type": "number",
      "description": "Mailbox ID"
    }
  }
}

helpscout_list_mailbox_fields

List all custom fields configured for a mailbox.

Args:

mailboxId: The mailbox ID
page: Page number (1-indexed)
format: Response format (json or markdown)

Returns custom field definitions including name, type, and options.

{
  "type": "object",
  "required": [
    "mailboxId"
  ],
  "properties": {
    "page": {
      "type": "integer",
      "default": 1,
      "minimum": 1,
      "description": "Page number"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "mailboxId": {
      "type": "number",
      "description": "Mailbox ID"
    }
  }
}

helpscout_list_saved_replies

List all saved replies (canned responses) for a mailbox.

Args:

mailboxId: The mailbox ID
page: Page number (1-indexed)
format: Response format (json or markdown)

{
  "type": "object",
  "required": [
    "mailboxId"
  ],
  "properties": {
    "page": {
      "type": "integer",
      "default": 1,
      "minimum": 1,
      "description": "Page number"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "mailboxId": {
      "type": "number",
      "description": "Mailbox ID"
    }
  }
}

helpscout_get_saved_reply

Get a single saved reply by ID.

Args:

mailboxId: The mailbox ID
savedReplyId: The saved reply ID
format: Response format (json or markdown)

{
  "type": "object",
  "required": [
    "mailboxId",
    "savedReplyId"
  ],
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "mailboxId": {
      "type": "number",
      "description": "Mailbox ID"
    },
    "savedReplyId": {
      "type": "number",
      "description": "Saved reply ID"
    }
  }
}

helpscout_create_saved_reply

Create a new saved reply (canned response) in a mailbox.

Args:

mailboxId: The mailbox ID
name: Name/title for the saved reply
text: The reply text content

{
  "type": "object",
  "required": [
    "mailboxId",
    "name",
    "text"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Saved reply name"
    },
    "text": {
      "type": "string",
      "description": "Reply text content"
    },
    "mailboxId": {
      "type": "number",
      "description": "Mailbox ID"
    }
  }
}

helpscout_update_saved_reply

Update an existing saved reply.

Args:

mailboxId: The mailbox ID
savedReplyId: The saved reply ID
name: New name/title
text: New reply text content

{
  "type": "object",
  "required": [
    "mailboxId",
    "savedReplyId",
    "name",
    "text"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Saved reply name"
    },
    "text": {
      "type": "string",
      "description": "Reply text content"
    },
    "mailboxId": {
      "type": "number",
      "description": "Mailbox ID"
    },
    "savedReplyId": {
      "type": "number",
      "description": "Saved reply ID"
    }
  }
}

helpscout_delete_saved_reply

Delete a saved reply from a mailbox.

Args:

mailboxId: The mailbox ID
savedReplyId: The saved reply ID to delete

{
  "type": "object",
  "required": [
    "mailboxId",
    "savedReplyId"
  ],
  "properties": {
    "mailboxId": {
      "type": "number",
      "description": "Mailbox ID"
    },
    "savedReplyId": {
      "type": "number",
      "description": "Saved reply ID"
    }
  }
}

helpscout_list_organizations

List all organizations (companies) in Help Scout.

Args:

sort: Sort field and direction (e.g., "name,asc", "lastInteractionAt,desc") Available fields: name, customerCount, conversationCount, lastInteractionAt
page: Page number (1-indexed)
format: Response format (json or markdown)

{
  "type": "object",
  "properties": {
    "page": {
      "type": "integer",
      "default": 1,
      "minimum": 1,
      "description": "Page number"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "json",
      "description": "Response format"
    }
  }
}

helpscout_get_organization

Get a single organization by ID.

Args:

organizationId: The organization ID
format: Response format (json or markdown)

{
  "type": "object",
  "required": [
    "organizationId"
  ],
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "organizationId": {
      "type": "number",
      "description": "Organization ID"
    }
  }
}

helpscout_create_organization

Create a new organization in Help Scout.

Args:

name: Organization name (required)
website: Website URL
description: Description text
location: Location string
logoUrl: Logo image URL
note: Internal notes
domains: Comma-separated list of domains
brandColor: Brand color hex code

{
  "type": "object",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Organization name"
    },
    "note": {
      "type": "string",
      "description": "Internal notes"
    },
    "domains": {
      "type": "string",
      "description": "Comma-separated domains"
    },
    "logoUrl": {
      "type": "string",
      "description": "Logo URL"
    },
    "website": {
      "type": "string",
      "description": "Website URL"
    },
    "location": {
      "type": "string",
      "description": "Location"
    },
    "brandColor": {
      "type": "string",
      "description": "Brand color hex"
    },
    "description": {
      "type": "string",
      "description": "Description"
    }
  }
}

helpscout_update_organization

Update an existing organization.

Args:

organizationId: The organization ID
name: New organization name
website: New website URL
description: New description
location: New location
logoUrl: New logo URL
note: New internal notes
domains: New comma-separated domains
brandColor: New brand color hex

{
  "type": "object",
  "required": [
    "organizationId"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Organization name"
    },
    "note": {
      "type": "string",
      "description": "Internal notes"
    },
    "domains": {
      "type": "string",
      "description": "Comma-separated domains"
    },
    "logoUrl": {
      "type": "string",
      "description": "Logo URL"
    },
    "website": {
      "type": "string",
      "description": "Website URL"
    },
    "location": {
      "type": "string",
      "description": "Location"
    },
    "brandColor": {
      "type": "string",
      "description": "Brand color hex"
    },
    "description": {
      "type": "string",
      "description": "Description"
    },
    "organizationId": {
      "type": "number",
      "description": "Organization ID"
    }
  }
}

helpscout_delete_organization

Delete an organization from Help Scout.

Args:

organizationId: The organization ID to delete

{
  "type": "object",
  "required": [
    "organizationId"
  ],
  "properties": {
    "organizationId": {
      "type": "number",
      "description": "Organization ID"
    }
  }
}

helpscout_list_ratings

List customer satisfaction ratings within a date range.

Args:

start: Start date in ISO 8601 format (required)
end: End date in ISO 8601 format (required)
mailbox: Filter by mailbox ID
rating: Filter by rating value (great, okay, bad)
sortField: Sort by field (rating, modifiedAt)
sortOrder: Sort direction (asc, desc)
page: Page number (1-indexed)
format: Response format (json or markdown)

{
  "type": "object",
  "required": [
    "start",
    "end"
  ],
  "properties": {
    "end": {
      "type": "string",
      "description": "End date (ISO 8601)"
    },
    "page": {
      "type": "integer",
      "default": 1,
      "minimum": 1,
      "description": "Page number"
    },
    "start": {
      "type": "string",
      "description": "Start date (ISO 8601)"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "json",
      "description": "Response format"
    },
    "rating": {
      "enum": [
        "great",
        "okay",
        "bad"
      ],
      "type": "string",
      "description": "Filter by rating"
    },
    "mailbox": {
      "type": "number",
      "description": "Filter by mailbox ID"
    },
    "sortField": {
      "enum": [
        "rating",
        "modifiedAt"
      ],
      "type": "string",
      "description": "Sort field"
    },
    "sortOrder": {
      "enum": [
        "asc",
        "desc"
      ],
      "type": "string",
      "description": "Sort direction"
    }
  }
}

helpscout_list_tags

List all tags in Help Scout.

Tags are shared across all mailboxes and returned in alphabetical order.

Args:

page: Page number (1-indexed)
format: Response format (json or markdown)

Returns tag details including name, color, and conversation count.

{
  "type": "object",
  "properties": {
    "page": {
      "type": "integer",
      "default": 1,
      "minimum": 1,
      "description": "Page number"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "json",
      "description": "Response format"
    }
  }
}

helpscout_list_teams

List all teams in Help Scout.

Args:

page: Page number (1-indexed)
format: Response format (json or markdown)

{
  "type": "object",
  "properties": {
    "page": {
      "type": "integer",
      "default": 1,
      "minimum": 1,
      "description": "Page number"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "json",
      "description": "Response format"
    }
  }
}

helpscout_list_team_members

List all members of a specific team.

Args:

teamId: The team ID
page: Page number (1-indexed)
format: Response format (json or markdown)

{
  "type": "object",
  "required": [
    "teamId"
  ],
  "properties": {
    "page": {
      "type": "integer",
      "default": 1,
      "minimum": 1,
      "description": "Page number"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "teamId": {
      "type": "number",
      "description": "Team ID"
    }
  }
}

helpscout_list_users

List all users in Help Scout.

Args:

email: Filter by exact email match
mailbox: Filter by mailbox ID
page: Page number (1-indexed)
format: Response format (json or markdown)

Returns users including pending invitations.

{
  "type": "object",
  "properties": {
    "page": {
      "type": "integer",
      "default": 1,
      "minimum": 1,
      "description": "Page number"
    },
    "email": {
      "type": "string",
      "description": "Filter by exact email"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "json",
      "description": "Response format"
    },
    "mailbox": {
      "type": "number",
      "description": "Filter by mailbox ID"
    }
  }
}

helpscout_get_user

Get a single user by ID.

Args:

userId: The user ID
format: Response format (json or markdown)

{
  "type": "object",
  "required": [
    "userId"
  ],
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "userId": {
      "type": "number",
      "description": "User ID"
    }
  }
}

helpscout_get_current_user

Get the currently authenticated user.

Args:

format: Response format (json or markdown)

{
  "type": "object",
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    }
  }
}

helpscout_list_webhooks

List all webhooks in Help Scout.

Args:

page: Page number (1-indexed)
format: Response format (json or markdown)

{
  "type": "object",
  "properties": {
    "page": {
      "type": "integer",
      "default": 1,
      "minimum": 1,
      "description": "Page number"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "json",
      "description": "Response format"
    }
  }
}

helpscout_get_webhook

Get a single webhook by ID.

Args:

webhookId: The webhook ID
format: Response format (json or markdown)

{
  "type": "object",
  "required": [
    "webhookId"
  ],
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string"
    },
    "webhookId": {
      "type": "number",
      "description": "Webhook ID"
    }
  }
}

helpscout_create_webhook

Create a new webhook in Help Scout.

Common events:

convo.assigned, convo.created, convo.deleted, convo.merged, convo.moved
convo.status, convo.tags, convo.customer.reply.created
customer.created, customer.updated
satisfaction.ratings

Args:

url: Endpoint URL to receive webhook notifications (required)
events: Comma-separated list of event types to subscribe to (required)
secret: Secret key for signature verification, max 40 chars (required)
label: Descriptive label for the webhook
notification: If true, only sends URL (no payload)
mailboxIds: Comma-separated mailbox IDs to scope webhook (omit for all)

{
  "type": "object",
  "required": [
    "url",
    "events",
    "secret"
  ],
  "properties": {
    "url": {
      "type": "string",
      "description": "Webhook endpoint URL"
    },
    "label": {
      "type": "string",
      "description": "Webhook label"
    },
    "events": {
      "type": "string",
      "description": "Comma-separated event types"
    },
    "secret": {
      "type": "string",
      "description": "Secret for signature verification"
    },
    "mailboxIds": {
      "type": "string",
      "description": "Comma-separated mailbox IDs"
    },
    "notification": {
      "type": "boolean",
      "default": false,
      "description": "Notification-only mode"
    }
  }
}

helpscout_update_webhook

Update an existing webhook.

Args:

webhookId: The webhook ID
url: New endpoint URL
events: New comma-separated event types
secret: New secret key
label: New label
state: Enable or disable (enabled, disabled)
notification: Notification-only mode
mailboxIds: Comma-separated mailbox IDs

{
  "type": "object",
  "required": [
    "webhookId"
  ],
  "properties": {
    "url": {
      "type": "string",
      "description": "Webhook endpoint URL"
    },
    "label": {
      "type": "string",
      "description": "Webhook label"
    },
    "state": {
      "enum": [
        "enabled",
        "disabled"
      ],
      "type": "string",
      "description": "Webhook state"
    },
    "events": {
      "type": "string",
      "description": "Comma-separated event types"
    },
    "secret": {
      "type": "string",
      "description": "Secret for verification"
    },
    "webhookId": {
      "type": "number",
      "description": "Webhook ID"
    },
    "mailboxIds": {
      "type": "string",
      "description": "Comma-separated mailbox IDs"
    },
    "notification": {
      "type": "boolean",
      "description": "Notification-only mode"
    }
  }
}

helpscout_delete_webhook

Delete a webhook.

Args:

webhookId: The webhook ID to delete

{
  "type": "object",
  "required": [
    "webhookId"
  ],
  "properties": {
    "webhookId": {
      "type": "number",
      "description": "Webhook ID"
    }
  }
}

helpscout_list_workflows

List all workflows in Help Scout.

Args:

mailboxId: Filter by mailbox ID
type: Filter by workflow type (manual, automatic)
page: Page number (1-indexed)
format: Response format (json or markdown)

{
  "type": "object",
  "properties": {
    "page": {
      "type": "integer",
      "default": 1,
      "minimum": 1,
      "description": "Page number"
    },
    "type": {
      "enum": [
        "manual",
        "automatic"
      ],
      "type": "string",
      "description": "Filter by workflow type"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "json",
      "description": "Response format"
    },
    "mailboxId": {
      "type": "number",
      "description": "Filter by mailbox ID"
    }
  }
}

helpscout_run_workflow

Run a manual workflow on one or more conversations.

Only manual workflows can be triggered via API.

Args:

workflowId: The workflow ID to run
conversationIds: Comma-separated list of conversation IDs

{
  "type": "object",
  "required": [
    "workflowId",
    "conversationIds"
  ],
  "properties": {
    "workflowId": {
      "type": "number",
      "description": "Workflow ID"
    },
    "conversationIds": {
      "type": "string",
      "description": "Comma-separated conversation IDs"
    }
  }
}

helpscout_update_workflow_status

Activate or deactivate a workflow.

Args:

workflowId: The workflow ID
status: New status (active, inactive)

{
  "type": "object",
  "required": [
    "workflowId",
    "status"
  ],
  "properties": {
    "status": {
      "enum": [
        "active",
        "inactive"
      ],
      "type": "string",
      "description": "New status"
    },
    "workflowId": {
      "type": "number",
      "description": "Workflow ID"
    }
  }
}