HelpDeskz User Guide

Welcome to HelpDeskZ

• Welcome to HelpDeskZ
• Server Requirements

Installation

• Fresh Installation
  • Configuration file
  • Install it!
• Upgrading from previous version
  • Upgrading from 1.x to 2.0
  • Upgrading from 2.0 to 2.0.1
  • Upgrading from 2.0.1 to 2.0.2
• HelpDeskZ Repositories

Configuration

• Email Piping
  • Email configuration
  • Email forwarding
• IMAP Fetching
  • Email configuration
  • Cron configuration

API

• API activation
  • Authentication and authorization
• Users
  • Create a new user
  • Retrieve a list of all users
  • Retrieve details of user by ID
  • Update user account
  • Delete user account
• Departments
  • Create a new department
  • Retrieve a list of all departments
  • Retrieve details of department by ID
  • Update department
  • Delete department
• Support Tickets
  • Create a new ticket
  • Retrieve a list of all tickets
  • Retrieve details of ticket by ID
  • Update ticket
  • Delete department
• Ticket Messages
  • Add a new message
  • Retrieve messages from a ticket
• Attachments
  • Retrieve list of attachments
  • Retrieve file content from an attachment
  • Delete attachment
• Staff
  • Retrieve a list of all staff users
  • Retrieve details of staff user by ID
  • Staff Authentication

Last revision: January 26th, 2021