Developer API Documentation

System-Wide POST Endpoints

Only Administrator users have access to System-Wide POST Endpoints. Be sure to use an administrator’s API Key in the following examples. Personal POST Endpoints can be used by any support agent.

All POST Endpoints should be pointed to the following URL:

https://api.ticksy.com/v1/DOMAIN/KEY/

Close a Ticket

// PHP Example Using the TicksyAPI Class

define('TICKSY_DOMAIN','DOMAIN');
define('TICKSY_KEY','KEY');
$post_vars = array(
  'action' => 'close_ticket',
  'ticket_id' => 123456
);

$ticksyAPI = new TicksyAPI();
$url = 'https://api.ticksy.com/v1/'.TICKSY_DOMAIN.'/'.TICKSY_KEY.'/';
$result = json_decode($ticksyAPI->ticksy_api_post($url,$post_vars),true);

Open a Ticket

// PHP Example Using the TicksyAPI Class

define('TICKSY_DOMAIN','DOMAIN');
define('TICKSY_KEY','KEY');

$post_vars = array(
   'action' => 'open_ticket',
   'ticket_id' => 123456
);

$ticksyAPI = new TicksyAPI();
$url = 'https://api.ticksy.com/v1/'.TICKSY_DOMAIN.'/'.TICKSY_KEY.'/';
$result = json_decode($ticksyAPI->ticksy_api_post($url,$post_vars),true);

Mark Ticket as Read (doesn’t need a response)

// PHP Example Using the TicksyAPI Class

define('TICKSY_DOMAIN','DOMAIN');
define('TICKSY_KEY','KEY');

$post_vars = array(
   'action' => 'mark_as_read',
   'ticket_id' => 123456
);

$ticksyAPI = new TicksyAPI();
$url = 'https://api.ticksy.com/v1/'.TICKSY_DOMAIN.'/'.TICKSY_KEY.'/';
$result = json_decode($ticksyAPI->ticksy_api_post($url,$post_vars),true);

Mark Ticket as Unread (needs a response)

// PHP Example Using the TicksyAPI Class

define('TICKSY_DOMAIN','DOMAIN');
define('TICKSY_KEY','KEY');

$post_vars = array(
   'action' => 'mark_as_unread',
   'ticket_id' => 123456
);

$ticksyAPI = new TicksyAPI();
$url = 'https://api.ticksy.com/v1/'.TICKSY_DOMAIN.'/'.TICKSY_KEY.'/';
$result = json_decode($ticksyAPI->ticksy_api_post($url,$post_vars),true);

Star a Ticket

// PHP Example Using the TicksyAPI Class

define('TICKSY_DOMAIN','DOMAIN');
define('TICKSY_KEY','KEY');

$post_vars = array(
   'action' => 'star_ticket',
   'ticket_id' => 123456
);

$ticksyAPI = new TicksyAPI();
$url = 'https://api.ticksy.com/v1/'.TICKSY_DOMAIN.'/'.TICKSY_KEY.'/';
$result = json_decode($ticksyAPI->ticksy_api_post($url,$post_vars),true);

Un-Star a Ticket

// PHP Example Using the TicksyAPI Class

define('TICKSY_DOMAIN','DOMAIN');
define('TICKSY_KEY','KEY');

$post_vars = array(
   'action' => 'unstar_ticket',
   'ticket_id' => 123456
);

$ticksyAPI = new TicksyAPI();
$url = 'https://api.ticksy.com/v1/'.TICKSY_DOMAIN.'/'.TICKSY_KEY.'/';
$result = json_decode($ticksyAPI->ticksy_api_post($url,$post_vars),true);

Create a new customer account

// PHP Example Using the TicksyAPI Class

define('TICKSY_DOMAIN','DOMAIN');
define('TICKSY_KEY','KEY');

$post_vars = array(
  'action' => 'new_customer',
  'first_name' => 'New Customer',
  'email_address' => '[email protected]',
  'password' => 'NewCustomerPwd'
);

$ticksyAPI = new TicksyAPI();
$url = 'https://api.ticksy.com/v1/'.TICKSY_DOMAIN.'/'.TICKSY_KEY.'/';
$result = json_decode($ticksyAPI->ticksy_api_post($url,$post_vars),true);