Field Reference

Complete specification of all fields accepted by our API endpoints, including types, validation rules, and usage examples.

Tickets API Fields

Field Name	Type	Required	Validation	Description	Example
title	string	Required	3-200 characters	Brief, descriptive title for the ticket	"Database connection issue"
description	string	Required	10-5000 characters	Detailed description of the issue or request	"Unable to connect to production database..."
priority	string	Optional	Enum: low, medium, high, urgent	Urgency level of the ticket	"high"
category	string	Optional	Max 50 characters	Categorization for routing and organization	"database"
status	string	Read-only	Enum: open, in_progress, resolved, closed	Current status of the ticket (set by system)	"open"
tags	string[]	Optional	Max 10 tags, each ≤ 30 chars	Array of tags for organization and filtering	["urgent", "production"]
customer_email	string	Optional	Valid email format	Customer email for notifications and updates	"user@company.com"
assigned_to	string	System	Valid email format	Agent email (automatically assigned by system)	"agent@support.com"
created_at	string	Read-only	ISO 8601 datetime	Ticket creation timestamp	"2024-01-15T10:30:00Z"
updated_at	string	Read-only	ISO 8601 datetime	Last update timestamp	"2024-01-15T14:20:00Z"
metadata	object	Optional	Max 10KB JSON	Custom key-value data for integrations	{order_id: 12345}

Field Name	Type	Required	Validation	Description	Example
url	string	Required	Valid HTTPS URL	Endpoint URL to receive webhook events	"https://api.company.com/webhooks"
events	string[]	Required	Array of valid event types	Events to subscribe to	["ticket.created", "ticket.resolved"]
secret	string	Optional	32-128 characters	Secret for webhook signature verification	"whsec_abc123..."
active	boolean	Read-only	true/false	Whether webhook is currently active	true