Socialboards
  • Developer hub
  • APIs
    • Ticket API
      • Getting Started
        • Guidelines and data privacy
      • Authorization
        • Access tokens
      • Categories
      • Custom Fields
      • Action Log
      • Notes
      • Replies
      • Tags
      • Tickets
      • Teammates
      • User Groups
      • Widgets
      • Webhooks
        • Getting Started
        • Create Endpoint
        • Configure the Webhooks
        • Testing your webhooks
      • Reference
        • Endpoints
          • Get Access Token v2
          • Get Full Community Category List
          • Get Subcategories by Parent Id
          • Get Category By Id
          • Get Full Community Custom Field List
          • Add Custom Field
          • Get Custom Field
          • Get All Teammates
          • Get All User Groups for Community
          • Update Custom Field
          • Delete Custom Field
          • Create Ticket
          • List Tickets
          • List Ticket Ids By Field Ids
          • Get Ticket by Id
          • Update Ticket Custom Field Value
          • Update Ticket Assignee
          • Get Ticket Log
          • Update Ticket Status
          • Update Ticket Category (Obsolete)
          • Update Ticket Category
          • Create Reply
          • List Replies
          • Add Note To Ticket
          • Update Note
          • Delete Note
          • List tags
          • Replace Ticket Tags
          • Replace Reply Tags
          • Get Widget Schedule List
        • API Request Result
        • Webhook Payload
        • Objects
          • Base Attachment
          • Category
          • Custom Field
          • Custom Field Id with Value
          • Custom Field Possible Value
          • Custom Field Value
          • Custom Times Widget Schedule
          • Note
          • Reply
          • Reply/Note Creator
          • Reply Properties
          • Schedule Time
          • Tag
          • Teammate
          • Ticket
          • Ticket Action Included Items
          • Ticket Creator
          • Ticket Id with Field Value
          • Ticket Log
          • Ticket Properties
          • User
          • User Group
          • Widget Schedule
        • Events
          • Ticket Creation
          • Ticket Status Change
          • Ticket Tags Change
          • Ticket Category Change
          • Reply Creation
          • Reply Update
          • Reply Deletion
          • Note Creation
          • Note Update
          • Note Deletion
        • Enumerations
          • Custom Field Types and Values Formats
          • Sentiment
          • Ticket Action Type
          • Ticket List Order By
          • Ticket Source
          • Ticket Status
          • User Role
          • Detailed Ticket Source
      • Glossary
    • External Chat API
      • Conversations Overview
      • Configure the Webhooks
      • Glossary
      • Reference
        • Endpoints
          • Create conversation
          • Add messages to conversation
          • Get conversation by id
          • List conversation messages
          • Get conversation queue information
          • Get takeover state
          • Change takeover state
          • Update conversation feedback
          • Update conversation latest url
          • Close conversation
        • Objects
          • Bot
          • Conversation
          • Conversation feedback
          • Conversation message
          • Conversation takeover
          • Conversation queue position
          • User
          • User Value
        • Events
          • Conversation created
          • Conversation Message Added
          • Conversation Takeover State Changed
          • Conversation Status Changed
        • Enumerations
          • Bot type
          • Order by
          • User status
          • Conversation Status
    • FAQ API
      • Glossary
      • Categories
      • FAQ Instances
      • Tags
      • Topics
      • Reference
        • Endpoints
          • List FAQ Instances
          • List Tags
          • List Categories
          • List Topics
          • Get Specific Topic
          • Add Vote to Topic
          • Increase View Count for Topic
          • Search Topics by Params
        • Objects
          • Attachment
          • Category
          • Instance
          • Tag
          • Topic
          • Topic Search Result
        • Enumerations
          • Localization Language
          • Template Type
          • Topic Downvote Reason
          • Topics Sort Options
    • Support Widget
      • Installation
      • Configuration options
      • Full script example
      • Javascript changelog
      • Widget schedule API
    • Reporting & Statistics
      • Data warehouse (DWH)
        • Entity relationship diagram (ERD)
        • Most used views and values
      • Reports and dashboards
  • Security
    • Introduction to Security
    • Data centers & network security
    • Product security features
    • Application security
    • Data Processing
    • Sub-Processors
      • 2023-04 Intility AS
        • Addendum 2023-4
  • Updates
    • Changelog
Powered by GitBook
On this page

Was this helpful?

  1. APIs
  2. Ticket API
  3. Reference
  4. Objects

Ticket

Example

{
	"id": 255762,
	"title": "New car price list.",
	"message": "Hello I want to buy a new car, how can I get a price list?",
	"htmlMessage": "<div id=\"sb-message-8dbf66986449599\" class=\"sb-html-message\">Hello I want to buy a new car, how can I get a price list?</div>",
	"author": {
		"email": "bill_smith@gmail.com",
		"id": "3561ab34-b6bd-4998-97e6-4ad5a58a89e8",
		"image": null,
		"isBot": false,
		"name": "Bill Smith",
		"status": "client"
	},
	"category": null,
	"creationTime": "2023-12-06T17:42:07.7888252+03:00",
    "customFields": [],
	"lastThreadElementCreationTime": "2023-12-06T17:42:07.7888252+03:00",
	"lockedBy": null,
	"originalLink": null,
	"properties": {
		"isAnonymized": false,
		"isMuted": false,
		"hasAttachments": true,
		"hasDraft": false,
		"isAssignedToBot": false,
		"isDeleted": false,
		"isExpired": false,
		"isHidden": false,
		"isLocked": false,
		"isSpam": false,
		"isSensitive": false
	},
	"replyCount": 0,
	"isMuted": false,
	"sentiment": "question",
	"source": "web",
	"detailedSource": "web_website",
	"sourceName": null,
	"status": "open",
	"tags": [],
	"attachments": [
		{
			"isContentPart": false,
			"name": "filename.png",
			"url": "https://your.attachment.url/filename.png"
		}
	]
}

Fields

Field
Type
Comments

attachments

Ticket attachments

author

Ticket creator

category

Ticket category. If null ticket has no category

creationTime

string

Indicates the time when the ticket was created. Represent datetime string in ISO 8601 format

customFields

Ticket custom fields

detailedSource

Indicates detailed ticket source

htmlMessage

string

Ticket html content

id

integer

Unique ticket id

lastThreadElementCreationTime

string

Indicates the time when the most recent element in a thread was created. Represent datetime string in ISO 8601 format

lockedBy

Teammate who assigned to the ticket

message

string

Ticket text content

originalLink

string

Permanent link or URL to the post if ticket created from SoMe source; if not, will be null

properties

Properties or attributes associated with a ticket

replyCount

integer

Indicates the total count of replies in the ticket

sentiment

Ticket sentiment

source

Indicates general ticket source

sourceName

string

Indicates the specific source where ticket from (e.g., page post, mention, group post, review, etc)

status

Current ticket status

tags

array of strings

Attached ticket tags

title

string

Ticket title

PreviousTeammateNextTicket Action Included Items

Last updated 6 months ago

Was this helpful?

array of models

model

model

array of models

enumeration

model

model

enumeration

enumeration

enumeration

Base Attachment
User
Category
array of Custom Field Id with Value models
Detailed Ticket Source
User
Ticket Properties
Sentiment
Ticket Source
Ticket Status