Guides

Helpdesk

Suggest Edits
Integration ProviderCompanyContactTicketUserOther
FreshDesk✅✅
FreshService✅
Front✅✅✅
Intercom✅✅✅Note
Re:amaze✅
Zendesk Support✅✅✅

Don't see the integration provider or resource you want? Let us know and we will build it out ASAP!


Company: helpdesk-company

A company is an organization that is being tracked.

{
  "address": {
    "title": "Address",
    "type": "object",
    "description": "Primary address of the company",
    "properties": {
      "primary_city": {
        "title": "Primary City",
        "type": "string",
        "description": "The city of the primary address."
      },
      "primary_country": {
        "title": "Primary Country",
        "type": "string",
        "description": "The country of the primary address."
      },
      "primary_postal_code": {
        "title": "Primary Postal Code",
        "type": "string",
        "description": "The postal or ZIP code of the primary address."
      },
      "primary_state": {
        "title": "Primary State",
        "type": "string",
        "description": "The state or region of the primary address."
      },
      "primary_street_1": {
        "title": "Primary Street 1",
        "type": "string",
        "description": "Line 1 of the street for the primary address."
      },
      "primary_street_2": {
        "title": "Primary Street 2",
        "type": "string",
        "description": "Line 2 of the street for the primary address."
      }
    }
  },
  "name": {
    "title": "Company Name",
    "type": "string"
  },
  "description": {
    "title": "Description",
    "type": "string"
  },
  "industry": {
    "title": "Industry",
    "description": "The field or industry that the company operates within.",
    "type": "string"
  },
  "number_of_employees": {
    "title": "Number of Employees",
    "type": "number"
  },
  "company_url": {
    "title": "Company URL",
    "type": "string",
    "format": "uri",
  }
}

{
  "address":
  {
    "primary_city": "New York",
    "primary_country": "USA",
    "primary_postal_code": "10001",
    "primary_state": "NY",
    "primary_street_1": "123 Main Street",
    "primary_street_2": "Apt 1"
  },
  "description": "A software development company specializing in AI applications.",
  "industry": "Technology",
  "name": "AI Solutions Inc.",
  "number_of_employees": 50,
  "company_url": "http://www.aisolutions.com"
}

Contact: helpdesk-contact

A contact is an individual who is being tracked.

{
        "address": {
            "title": "Address",
            "type": "object",
            "description": "The primary address of the contact",
            "properties": {
              "primary_city": {
                "title": "Primary City",
                "type": "string",
                "description": "The city of the primary address."
              },
              "primary_country": {
                "title": "Primary Country",
                "type": "string",
                "description": "The country of the primary address."
              },
              "primary_postal_code": {
                "title": "Primary Postal Code",
                "type": "string",
                "description": "The postal or ZIP code of the primary address."
              },
              "primary_state": {
                "title": "Primary State",
                "type": "string",
                "description": "The state or region of the primary address."
              },
              "primary_street_1": {
                "title": "Primary Street 1",
                "type": "string",
                "description": "Line 1 of the street for the primary address."
              },
              "primary_street_2": {
                "title": "Primary Street 2",
                "type": "string",
                "description": "Line 2 of the street for the primary address."
              }
            }
        },
        "company": {
            "title": "Company",
            "type": "string"
        },
        "company_url": {
            "title": "Company URL",
            "type": "string",
            "format": "uri",
        },
        "email_address": {
            "format": "email",
            "title": "Email Address",
            "type": "string",
            "description":"Primary email address of the contact"
        },
        "first_name": {
            "title": "First Name",
            "type": "string"
        },
        "last_name": {
            "title": "Last Name",
            "type": "string"
        },
        "title": {
            "title": "Title",
            "type": "string",
        },
        "phone_number": {
            "title": "Phone Number",
            "type": "string",
            "description":"Primary phone number of the contact"
        }
    }

{
  "first_name": "John",
  "last_name": "Doe",
  "title": "Manager",
  "address":
  {
    "primary_street_1": "123 Main St",
    "primary_city": "Anytown",
    "primary_state": "NY",
    "primary_postal_code": "12345",
    "primary_country": "USA"
  },
  "email_address": "[email protected]",
  "phone_number": "123-456-7890"
}

Ticket: helpdesk-ticket

A ticket is a note for the company to fix an issue.

{
  "type": {
    "title": "Type",
    "type": "string",
    "description": "The type of the ticket."
  },
  "subject": {
    "title": "Subject",
    "type": "string",
    "description": "The subject of the ticket."
  },
  "description": {
    "title": "Description",
    "type": "string",
    "description": "The description of the ticket."    
  },
  "status": {
    "enum": [
      "OPEN",
      "IN_PROGRESS",
      "CLOSED",
    ],
    "type": "string",
    "description": "The status of the ticket."
  },
  "priority": {
    "enum": [
      "LOW",
      "NORMAL",
      "HIGH",
      "URGENT"
    ],
    "type": "string",
    "description": "The priority of the ticket."
  },
  "assignees": {
    "title": "Assignees",
    "type": "array",
    "items": {
      "type": "object",
      "properties": {
        "user_id": {
          "title": "User ID",
          "type": "string",
          "description": "The unique identifier for the user assigned to the ticket."
        }
      }
    }
  },
  "due_date": {
    "format": "date-time",
    "title": "Due Date",
    "type": "string"
  },
  "completed_date": {
    "format": "date-time",
    "title": "Completed Date",
    "type": "string"
  },
}

{
  "type": "Bug Report",
  "subject": "Login Page Not Loading",
  "description": "Users are reporting that the login page fails to load, displaying a blank screen instead.",
  "status": "IN_PROGRESS",
  "priority": "HIGH",
  "assignees": [
    {
      "user_id": "a6030fb0"
    },
    {
      "user_id": "a6030fb1"
    }
  ],
  "due_date": "2024-02-28 10:15:00",
}

User: helpdesk-user

A user is a person with access to the helpdesk.

{
  "first_name": {
    "title": "First Name",
    "type": "string"
  },
  "last_name": {
    "title": "Last Name",
    "type": "string"
  },
  "display_name": {
    "title": "Display Name",
    "type": "string"
  },
  "email": {
    "title": "Email",
    "type": "string",
    "format": "email"
  }
}

{
  "first_name":"John",
  "last_name":"Doe",
  "display_name":"John Doe",
  "email":"[email protected]"
}

Updated 2 months ago