Skip to main content
Gately Helpdesk provides a complete customer support solution with ticket management, knowledge base, and AI-powered assistance.

Features

Ticket Management

Track and resolve customer issues

Knowledge Base

Self-service help articles

AI Assistant

AI-powered response suggestions

Email Integration

Support via email

Ticket Management

Ticket Properties

PropertyDescription
IDUnique ticket identifier
SubjectTicket title
StatusOpen, In Progress, Resolved, Closed
PriorityLow, Medium, High, Urgent
AssigneeTeam member handling the ticket
TagsCategorization labels
CreatedSubmission timestamp

Ticket Workflow

Managing Tickets

  1. View all tickets in Helpdesk > Tickets
  2. Filter by status, priority, or assignee
  3. Click to view ticket details
  4. Reply, assign, or change status

Knowledge Base

Creating Articles

  1. Go to Helpdesk > Articles
  2. Click New Article
  3. Write content using the rich text editor
  4. Assign to a category
  5. Publish

Article Structure

FieldDescription
TitleArticle headline
SlugURL-friendly identifier
ContentArticle body (Markdown supported)
CategoryOrganizational category
TagsSearch keywords
StatusDraft or Published

Categories

Organize articles into categories:
  • Getting Started
  • Account & Billing
  • Features
  • Troubleshooting
  • API & Developers

Help Center Portal

Provide a public help center for your users:

Setup

  1. Go to Helpdesk > Settings > Portal
  2. Configure branding (logo, colors)
  3. Set custom domain (optional)
  4. Enable/disable features

Portal Features

  • Article search
  • Category browsing
  • Contact form
  • Ticket submission
  • User ticket history

Chat Widget

Add a real-time chat widget to your website for instant customer support.

Installation

The easiest way to add the chat widget to your website:
<!-- Add before the closing </body> tag -->
<script src="https://static-widget-v1.usegately.com/gately-widget.iife.js" defer></script>
<gately-chat-widget project-id="your-project-id"></gately-chat-widget>

Configuration Options

Customize the widget with HTML attributes:
<gately-chat-widget
  project-id="your-project-id"
  primary-color="#3b82f6"
  portal-name="Support"
  show-branding="true"
  ai-agent-enabled="false"
></gately-chat-widget>
AttributeTypeDefaultDescription
project-idstringrequiredYour Gately project ID
primary-colorstring#3b82f6Widget theme color
portal-namestringSupportWidget title
show-brandingbooleantrueShow “Powered by Gately”
ai-agent-enabledbooleanfalseEnable AI responses

Widget Features

  • Real-time Chat - Instant messaging with your support team
  • File Uploads - Users can send screenshots and attachments
  • AI Assistance - AI-powered responses from your help articles
  • Customizable - Match your brand colors and style
  • Mobile Optimized - Works perfectly on all devices
  • Auto-Updates - Always get the latest features automatically

Platform Integration

The widget works on any platform that supports custom HTML:
Add the code before the closing </body> tag in your HTML file.
Use useEffect to load the widget dynamically:
useEffect(() => {
  const script = document.createElement('script');
  script.src = 'https://static-widget-v1.usegately.com/gately-widget.iife.js';
  script.defer = true;
  document.head.appendChild(script);
  
  script.onload = () => {
    const widget = document.createElement('gately-chat-widget');
    widget.setAttribute('project-id', 'your-project-id');
    document.body.appendChild(widget);
  };
}, []);
Add to your theme’s footer.php or use a plugin like “Insert Headers and Footers”.
Go to Online Store → Themes → Actions → Edit code → theme.liquid and add before </body>.

Customization

Customize the widget appearance in Dashboard → Help Center → Widget:
  1. Appearance - Colors, theme mode, button icon
  2. Branding - Logo, hide Gately branding (Pro)
  3. Content - Welcome message, placeholder text
  4. Behavior - Auto-open, sound notifications
  5. Features - Enable chat, AI agent, file uploads
Changes are applied automatically to your widget without code updates.

Email Support

Inbound Email

Receive support emails and convert to tickets:
  1. Go to Helpdesk > Settings > Email
  2. Configure your support email address
  3. Set up email forwarding to Gately
  4. Incoming emails become tickets

Email Notifications

Configure notifications for:
EventDescription
New TicketCustomer submits ticket
Reply ReceivedCustomer replies
Ticket AssignedTicket assigned to agent
Status ChangedTicket status updated

AI Assistant

Features

  • Response Suggestions: AI suggests replies based on context
  • Article Recommendations: Suggest relevant help articles
  • Auto-categorization: Automatically tag and prioritize tickets
  • Sentiment Analysis: Detect customer sentiment

Using AI Suggestions

  1. Open a ticket
  2. Click AI Suggest button
  3. Review suggested response
  4. Edit and send

API Usage

List Tickets

curl -X GET "https://api.usegately.com/api/v1/helpdesk/tickets" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-Project-ID: your-project-id"

Create Ticket

curl -X POST "https://api.usegately.com/api/v1/helpdesk/tickets" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-Project-ID: your-project-id" \
  -H "Content-Type: application/json" \
  -d '{
    "subject": "Cannot login to my account",
    "message": "I am getting an error when trying to login...",
    "email": "[email protected]",
    "priority": "high"
  }'

Reply to Ticket

curl -X POST "https://api.usegately.com/api/v1/helpdesk/tickets/{ticket_id}/replies" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-Project-ID: your-project-id" \
  -H "Content-Type: application/json" \
  -d '{
    "message": "Thanks for reaching out. Let me help you with that..."
  }'

Integrations

Slack

Get ticket notifications in Slack:
  1. Go to Helpdesk > Settings > Integrations
  2. Connect Slack workspace
  3. Select notification channel
  4. Choose events to notify

Webhooks

{
  "event": "ticket.created",
  "data": {
    "id": "tkt_123",
    "subject": "Login issue",
    "status": "open",
    "priority": "high",
    "customer_email": "[email protected]"
  }
}

Best Practices

Set SLA targets and monitor response times. Aim for under 24 hours for first response.
Create templates for common questions to speed up responses.
Document common issues to reduce ticket volume.
Use consistent tags to track issue patterns and improve your product.