Helpdesk
helpdesk-company
helpdesk-company{
"id": {
"type": "string",
"title": "ID",
"description": "The unique identifier of the object."
},
"addresses": {
"items": {
"properties": {
"address_type": {
"enum": [
"PRIMARY",
"SECONDARY",
"OFFICE",
"SHIPPING",
"BILLING",
"OTHER"
],
"title": "Address Type",
"type": "string"
},
"city": {
"title": "City",
"type": "string"
},
"country": {
"title": "Country",
"type": "string"
},
"postal_code": {
"title": "Postal Code",
"type": "string"
},
"state": {
"title": "State",
"type": "string"
},
"street_1": {
"title": "Street 1",
"type": "string"
},
"street_2": {
"title": "Street 2",
"type": "string"
}
},
"type": "object"
},
"title": "Addresses",
"type": "array"
},
"description": {
"title": "Description",
"type": "string"
},
"industry": {
"title": "Industry",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
},
"number_of_employees": {
"title": "Number of Employees",
"type": "number"
},
"phone_numbers": {
"items": {
"properties": {
"phone_number": {
"title": "Phone Number",
"type": "string"
},
"phone_type": {
"enum": [
"HOME",
"WORK",
"PERSONAL",
"MOBILE",
"OTHER"
],
"title": "Phone Type",
"type": "string"
}
},
"type": "object"
},
"title": "Phone Numbers",
"type": "array"
},
"website": {
"format": "uri",
"title": "Website",
"type": "string"
}
}
Example Object:
{
"id": "20406724619",
"addresses": [
{
"address_type": "PRIMARY",
"city": "New York",
"country": "USA",
"postal_code": "10001",
"state": "NY",
"street_1": "123 Main Street",
"street_2": "Apt 1"
},
{
"address_type": "OFFICE",
"city": "Los Angeles",
"country": "USA",
"postal_code": "90001",
"state": "CA",
"street_1": "456 Business Avenue",
"street_2": "Suite 200"
}
],
"description": "A software development company specializing in AI applications.",
"industry": "Technology",
"name": "AI Solutions Inc.",
"number_of_employees": 50,
"phone_numbers": [
{
"phone_number": "123-456-7890",
"phone_type": "WORK"
},
{
"phone_number": "987-654-3210",
"phone_type": "MOBILE"
}
],
"website": "http://www.aisolutions.com"
}
helpdesk-contact
helpdesk-contact{
"id": {
"type": "string",
"title": "ID",
"description": "The unique identifier of the object."
},
"addresses": {
"items": {
"properties": {
"address_type": {
"enum": [
"PRIMARY",
"SECONDARY",
"OFFICE",
"SHIPPING",
"BILLING",
"OTHER"
],
"title": "Address Type",
"type": "string"
},
"city": {
"title": "City",
"type": "string"
},
"country": {
"title": "Country",
"type": "string"
},
"postal_code": {
"title": "Postal Code",
"type": "string"
},
"state": {
"title": "State",
"type": "string"
},
"street_1": {
"title": "Street 1",
"type": "string"
},
"street_2": {
"title": "Street 2",
"type": "string"
}
},
"type": "object"
},
"title": "Addresses",
"type": "array"
},
"email_addresses": {
"items": {
"properties": {
"email_address": {
"format": "email",
"title": "Email Address",
"type": "string"
},
"email_type": {
"enum": [
"WORK",
"PERSONAL",
"OTHER"
],
"title": "Email Type",
"type": "string"
}
},
"type": "object"
},
"title": "Email Addresses",
"type": "array"
},
"first_name": {
"title": "First Name",
"type": "string"
},
"last_name": {
"title": "Last Name",
"type": "string"
},
"phone_numbers": {
"items": {
"properties": {
"phone_number": {
"title": "Phone Number",
"type": "string"
},
"phone_type": {
"enum": [
"HOME",
"WORK",
"PERSONAL",
"MOBILE",
"OTHER"
],
"title": "Phone Type",
"type": "string"
}
},
"type": "object"
},
"title": "Phone Numbers",
"type": "array"
}
}
Example Object:
{
"id": "20406724619",
"first_name": "John",
"last_name": "Doe",
"addresses": [
{
"address_type": "PRIMARY",
"street_1": "123 Main St",
"city": "Anytown",
"state": "NY",
"postal_code": "12345",
"country": "USA"
},
{
"address_type": "SECONDARY",
"street_1": "456 Elm St",
"city": "Othertown",
"state": "CA",
"postal_code": "67890",
"country": "USA"
}
],
"email_addresses": [
{
"email_address": "[email protected]",
"email_type": "WORK"
},
{
"email_address": "[email protected]",
"email_type": "PERSONAL"
}
],
"phone_numbers": [
{
"phone_number": "123-456-7890",
"phone_type": "HOME"
},
{
"phone_number": "987-654-3210",
"phone_type": "MOBILE"
}
]
}
helpdesk-note
helpdesk-note{
"company_name": {
"title": "Company",
"type": "string"
},
"content": {
"title": "Content",
"type": "string"
},
"date_created": {
"format": "date-time",
"title": "Date",
"type": "string"
},
"subject": {
"title": "Title",
"type": "string"
}
}
Example Object:
{
"company_name": "SupportTech Solutions",
"content": "Resolved ticket #12345. User's issue with email configuration has been fixed. Sent confirmation email.",
"date_created": "2024-02-28 10:15:00",
"subject": "Ticket #12345 Resolution"
}
helpdesk-user
helpdesk-user{
"email_addresses": {
"items": {
"properties": {
"email_address": {
"format": "email",
"title": "Email Address",
"type": "string"
},
"email_type": {
"enum": [
"WORK",
"PERSONAL",
"OTHER"
],
"title": "Email Type",
"type": "string"
}
},
"type": "object"
},
"title": "Email Addresses",
"type": "array"
},
"is_active": {
"title": "Active",
"type": "boolean"
},
"name": {
"title": "Name",
"type": "string"
}
}
Example Object:
{
"email_addresses": [
{
"email_address": "[email protected]",
"email_type": "WORK"
},
{
"email_address": "[email protected]",
"email_type": "PERSONAL"
}
],
"is_active": true,
"name": "John Doe"
}
helpdesk-ticket
helpdesk-ticket{
"id": {
"type": "string"
},
"subject": {
"type": "string"
},
"status": {
"type": "string"
},
"assignee": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"email": {
"type": "string",
"format": "email"
},
"username": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"is_admin": {
"type": "boolean"
},
"is_available": {
"type": "boolean"
},
"is_blocked": {
"type": "boolean"
}
}
},
"recipient": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"handle": {
"type": "string",
"format": "email"
},
"role": {
"type": "string"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"highlight": {
"type": [
"string",
"null"
]
},
"is_private": {
"type": "boolean"
},
"is_visible_in_conversation_lists": {
"type": "boolean"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
}
}
}
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"external_url": {
"type": "string",
"format": "uri"
}
}
}
},
"created_at": {
"type": "string",
"format": "date-time"
},
"waiting_since": {
"type": "string",
"format": "date-time"
},
"is_private": {
"type": "boolean"
},
"scheduled_reminders": {
"type": "array",
"items": {
"type": "object",
"properties": {
"created_at": {
"type": "string",
"format": "date-time"
},
"scheduled_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
}
}
}
},
"metadata": {
"type": "object",
"properties": {
"external_conversation_ids": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"is_inbound": {
"type": "boolean"
},
"draft_mode": {
"type": "string"
},
"error_type": {
"type": [
"string",
"null"
]
},
"version": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"subject": {
"type": "string"
},
"blurb": {
"type": "string"
},
"author": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"email": {
"type": "string",
"format": "email"
},
"username": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"is_admin": {
"type": "boolean"
},
"is_available": {
"type": "boolean"
},
"is_blocked": {
"type": "boolean"
}
}
},
"recipients": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"handle": {
"type": "string",
"format": "email"
},
"role": {
"type": "string"
}
}
}
},
"body": {
"type": "string"
},
"text": {
"type": "string"
},
"attachments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"filename": {
"type": "string"
},
"url": {
"type": "string",
"format": "uri"
},
"content_type": {
"type": "string"
},
"size": {
"type": "integer"
},
"metadata": {
"type": "object",
"properties": {
"is_inline": {
"type": "boolean"
},
"cid": {
"type": "string"
}
}
}
}
}
},
"signature": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"body": {
"type": "string"
},
"sender_info": {
"type": "string"
},
"is_visible_for_all_teammate_channels": {
"type": "boolean"
},
"is_default": {
"type": "boolean"
},
"is_private": {
"type": "boolean"
},
"channel_ids": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"metadata": {
"type": "object",
"properties": {
"intercom_url": {
"type": "string",
"format": "uri"
},
"duration": {
"type": "integer"
},
"have_been_answered": {
"type": "boolean"
},
"external_id": {
"type": "string"
},
"twitter_url": {
"type": "string",
"format": "uri"
},
"is_retweet": {
"type": "boolean"
},
"have_been_retweeted": {
"type": "boolean"
},
"have_been_favorited": {
"type": "boolean"
},
"thread_ref": {
"type": "string"
},
"headers": {
"type": "object"
},
"chat_visitor_url": {
"type": "string",
"format": "uri"
}
}
}
}
}
}
}
Example Object:
{
"id": "cnv_yo1kg5q",
"subject": "How to prank Dwight Schrute",
"status": "assigned",
"assignee": {
"id": "tea_6r55a",
"email": "[email protected]",
"username": "PrisonMike",
"first_name": "Michael",
"last_name": "Scott",
"is_admin": true,
"is_available": false,
"is_blocked": false
},
"recipient": {
"name": "Phyllis Lapin-Vance",
"handle": "[email protected]",
"role": "cc"
},
"tags": [
{
"id": "tag_2oxhvy",
"name": "Warehouse task",
"description": "Sitting on your biscuit, never having to risk it",
"highlight": null,
"is_private": false,
"is_visible_in_conversation_lists": true,
"created_at": "2000-01-01 00:00:00",
"updated_at": "2000-01-01 00:00:00"
}
],
"links": [
{
"id": "top_b2wpa",
"name": "JIRA-SCRAN-4567",
"type": "app_2f76b9ac738de158",
"external_url": "https://dundermifflin.atlassian.net/browse/PB-SCRAN-4567"
}
],
"created_at": "2000-01-01 00:00:00",
"waiting_since": "2000-01-01 00:00:00",
"is_private": true,
"scheduled_reminders": [
{
"created_at": "2000-01-01 00:00:00",
"scheduled_at": "2000-01-01 00:00:00",
"updated_at": "2000-01-01 00:00:00"
}
],
"metadata": {
"external_conversation_ids": [
"JS3949",
"JS9403"
]
},
"messages": [
{
"id": "msg_1q15qmtq",
"type": "email",
"is_inbound": false,
"draft_mode": "shared",
"error_type": null,
"version": "551ba368f3e7803cce51503ee3e58ef0-26028-1701804863304-945c",
"created_at": "2000-01-01 00:00:00",
"subject": "Jim's pranks are getting out of hand",
"blurb": "It's high time we discuss the pranking culture in the office",
"author": {
"id": "tea_6r55a",
"email": "[email protected]",
"username": "PrisonMike",
"first_name": "Michael",
"last_name": "Scott",
"is_admin": true,
"is_available": false,
"is_blocked": false
},
"recipients": [
{
"name": "Phyllis Lapin-Vance",
"handle": "[email protected]",
"role": "cc"
}
],
"body": "<p>Hi there,</p><p>I wanted to let you know that I'm suggesting an update to <a href='https://dundermifflin.com/privacy/pranks'>Dunder Mifflin's Pranking Policy</a> to provide non-humorous employees greater control over their well-being in the office.</p>",
"text": "Hi there,\\n\\nI wanted to let you know that I'm suggesting an update to Dunder Mifflin's Pranking Policy (https://dundermifflin.com/privacy/pranks) to provide non-humorous employees greater control over their well-being in the office.",
"attachments": [
{
"id": "fil_3q8a7mby",
"filename": "Andy_Anger_Management_Certificate.png",
"url": "https://yourCompany.api.frontapp.com/download/fil_3q8a7mby",
"content_type": "image/png",
"size": 4405,
"metadata": {
"is_inline": true,
"cid": "526b45586d0e6b1c484afab63d1ef0be"
}
}
],
"signature": {
"id": "sig_6rrv2",
"name": "Finer Things Club signature",
"body": "<div>—<br />{{user.name}}<br />No paper, no plastic, and no work talk allowed<br /></div>",
"sender_info": "Michael",
"is_visible_for_all_teammate_channels": true,
"is_default": false,
"is_private": true,
"channel_ids": [
"45"
]
},
"metadata": {
"intercom_url": "http://intercom.com",
"duration": 189,
"have_been_answered": false,
"external_id": "dkd84992kduo903",
"twitter_url": "https://twitter.com",
"is_retweet": true,
"have_been_retweeted": true,
"have_been_favorited": false,
"thread_ref": "t0930k9000-394",
"headers": {},
"chat_visitor_url": "https://yourCompany.com/products"
}
}
]
}
Updated 3 months ago