Appearance

Create Tickets ​

Endpoint ​

http
POST /unified/ticketing/tickets
Integrations supported
  • Asana
  • Bitbucket
  • Freshdesk
  • Gorgias
  • Help Scout
  • Jira
  • Salesforce
  • Trello
  • Zendesk

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified will return the response with unified mappings applied.
  • raw will return the raw response from the remote API.
  • normalized will apply the unified mappings and return the data in a normalized format.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar

Request Body ​

Refer Writing data using Unified APIs

name
string

The name of the ticket

Required in
  • Bitbucket
  • Gorgias
  • Help Scout
  • Jira
  • Trello
Supported in
  • Asana
  • Freshdesk
  • Salesforce
  • Zendesk
collections
object[]

Collections associated with the ticket. One of parent_ticket, workspace or collections should be specified.

Required in
  • Asana
  • Bitbucket
  • Help Scout
  • Jira
  • Trello
id
string

The unique identifier for a collection

name
string

The name of the collection

status
object

The status of the ticket

All possible enum values:
  • open
  • closed
  • pending
  • completed
  • approved
  • rejected
  • changes_requested
Enum support by integration
  • Gorgias
    • open
    • closed
  • Asana
    • pending
    • completed
    • approved
    • rejected
    • changes_requested
Required in
  • Help Scout
Supported in
  • Asana
  • Bitbucket
  • Freshdesk
  • Gorgias
  • Zendesk
id
string

The unique identifier for a status

name
string

The name of the status

All possible enum values:
  • active
  • closed
  • open
  • pending
  • spam
  • resolved
  • archived
  • deleted
  • completed
contact
object

Contact associated with the ticket

Required in
  • Freshdesk
  • Help Scout
Supported in
  • Gorgias
  • Salesforce
  • Zendesk
id
string

The unique identifier for a contact

first_name
string

The first name of the contact

last_name
string

The last name of the contact

name
string

The name of the contact

emails
object[]

The emails of the contact

email
string
REQUIRED · 

The email of the contact

type
string

The type of the email

comment
object

The comment to add to the ticket. The comment body has a limit of 4000 bytes.

Required in
  • Freshdesk
  • Gorgias
  • Help Scout
  • Zendesk
Supported in
  • Salesforce
author
object

The id of the user or contact who created the comment

id
string

The id of the user or contact who created the comment

type
string
REQUIRED · 

Type of the author

All possible enum values:
  • user
  • contact
  • user
  • contact
  • user
  • contact
  • user
  • contact
  • user
  • contact
emails
object[]

The emails of the author

email
string
REQUIRED · 

The email of the author

type
string

The type of the email

body
string
REQUIRED · 

The body of the comment

html_body
string
REQUIRED · 

The body of the comment in HTML format

assignees
object[]

Users assigned to the ticket

Supported in
  • Asana
  • Bitbucket
  • Gorgias
  • Help Scout
  • Jira
  • Trello
  • Zendesk
id
string

The unique identifier for a user

name
string

The name of the user

first_name
string

The first name of the user

last_name
string

The last name of the user

emails
object[]

The user's email addresses

email
string
REQUIRED · 

The user's email address

type
string

The type of email address

created_at
string · date-time

Time at which the ticket was created

Supported in
  • Gorgias
  • Help Scout
tags
object[]

Tags associated with the ticket

Supported in
  • Asana
  • Freshdesk
  • Gorgias
  • Help Scout
  • Jira
  • Trello
  • Zendesk
id
string

The unique identifier for a tag

name
string

The name of the tag

completed_at
string · date-time

Time at which the ticket was completed

Supported in
  • Gorgias
  • Help Scout
updated_at
string · date-time

Time at which the ticket was last updated

Supported in
  • Gorgias
number
string

An optional ticket number maintained by the system.

Supported in
  • Gorgias
  • Zendesk
languages
string[]

Languages of the ticket

Supported in
  • Gorgias
priority
object

Priority of the ticket

Supported in
  • Bitbucket
  • Freshdesk
  • Jira
  • Zendesk
id
string

The unique identifier for a priority

name
string

The name of the priority

due_date
string · date-time

Due date of the ticket

Supported in
  • Asana
  • Freshdesk
  • Jira
  • Trello
  • Zendesk
ticket_type
object

Type of the ticket

All possible enum values:
  • default_task
  • milestone
  • section
  • approval
Enum support by integration
  • Asana
    • default_task
    • milestone
    • section
    • approval
Required in
  • Jira
Supported in
  • Asana
  • Bitbucket
  • Freshdesk
  • Zendesk
id
string

The unique identifier for a ticket type

name
string

The name of the ticket type

parent_ticket
object

Parent ticket associated with the ticket. One of parent_ticket, workspace or collections should be specified.

Required in
  • Asana
Supported in
  • Jira
id
string

The unique identifier for a ticket

name
string

The name of the ticket

description
string

Description of the ticket

Supported in
  • Asana
  • Bitbucket
  • Jira
  • Salesforce
  • Trello
custom_fields
object

Custom fields to set on the ticket

Supported in
  • Jira
html_description
string · html

The HTML description of the task

Supported in
  • Asana
workspace
string

The unique identifier for the workspace. One of parent_ticket, workspace or collections should be specified.

Required in
  • Asana
  • Bitbucket
id
string

The unique identifier for a workspace

name
string

The name of the workspace

source
object
Supported in
  • Salesforce
id
string

The unique identifier for a source

name
string

The name of the source

remote_data
object

Any additional data that should be passed as part of the request body. This data is not transformed by Truto and is passed as is to the remote API.

Response Body ​

id
string
REQUIRED · 

The unique identifier for a ticket

Supported in
  • Asana
  • Bitbucket
  • Gorgias
  • Jira
  • Trello
  • Zendesk
name
string

The name of the ticket

Supported in
  • Asana
  • Bitbucket
  • Gorgias
  • Jira
  • Trello
  • Zendesk
number
string

An optional ticket number maintained by the system.

Supported in
  • Gorgias
assignees
object[]

Users assigned to the ticket

Supported in
  • Asana
  • Bitbucket
  • Gorgias
  • Jira
  • Trello
  • Zendesk
id
string

The unique identifier for a user

name
string

The name of the user

first_name
string

The first name of the user

last_name
string

The last name of the user

emails
object[]

The user's email addresses

email
string
REQUIRED · 

The user's email address

type
string

The type of email address

status
object

The status of the ticket

Supported in
  • Bitbucket
  • Gorgias
  • Jira
  • Trello
  • Zendesk
id
string

The unique identifier for a status

name
string

The name of the status

All possible enum values:
  • active
  • closed
  • open
  • pending
  • spam
  • resolved
  • archived
  • deleted
  • completed
created_by
object

User or contact who created the ticket

Supported in
  • Bitbucket
  • Gorgias
  • Jira
  • Zendesk
id
string

The unique identifier for a user

name
string

The name of the user

type
string

The type of the user

All possible enum values:
  • user
  • contact
due_date
string · date-time

Due date of the ticket

Supported in
  • Asana
  • Jira
  • Trello
  • Zendesk
description
string

Description of the ticket

Supported in
  • Asana
  • Bitbucket
  • Gorgias
  • Jira
  • Trello
  • Zendesk
workspace
object

Workspace associated with the ticket

Supported in
  • Bitbucket
  • Trello
id
string

The unique identifier for a workspace

name
string

The name of the workspace

team
object

Team associated with the ticket

id
string

The unique identifier for a team

name
string

The name of the team

collections
object[]

Collections associated with the ticket

Supported in
  • Asana
  • Bitbucket
  • Jira
  • Trello
id
string

The unique identifier for a collection

name
string

The name of the collection

ticket_type
object

Type of the ticket

Supported in
  • Asana
  • Bitbucket
  • Jira
  • Zendesk
id
string

The unique identifier for a ticket type

name
string

The name of the ticket type

contact
object

Contact associated with the ticket

Supported in
  • Gorgias
  • Zendesk
id
string

The unique identifier for a contact

first_name
string

The first name of the contact

last_name
string

The last name of the contact

name
string

The name of the contact

emails
object[]

The emails of the contact

email
string
REQUIRED · 

The email of the contact

type
string

The type of the email

parent_ticket
object

Parent ticket associated with the ticket

Supported in
  • Asana
  • Jira
id
string

The unique identifier for a ticket

name
string

The name of the ticket

attachments
object[]

Attachments associated with the ticket

Supported in
  • Asana
  • Jira
id
string

The unique identifier for an attachment

file_name
string

The name of the attachment

file_url
string

The url of the attachment

tags
object[]

Tags associated with the ticket

Supported in
  • Asana
  • Gorgias
  • Jira
  • Trello
  • Zendesk
id
string

The unique identifier for a tag

name
string

The name of the tag

created_at
string · date-time

Time at which the ticket was created

Supported in
  • Asana
  • Bitbucket
  • Gorgias
  • Jira
  • Trello
  • Zendesk
updated_at
string · date-time

Time at which the ticket was last updated

Supported in
  • Asana
  • Bitbucket
  • Gorgias
  • Jira
  • Trello
  • Zendesk
completed_at
string · date-time

Time at which the ticket was completed

Supported in
  • Asana
  • Gorgias
  • Jira
ticket_url
string

URL of the ticket

Supported in
  • Asana
  • Bitbucket
  • Jira
  • Trello
  • Zendesk
priority
object

Priority of the ticket

Supported in
  • Bitbucket
  • Gorgias
  • Jira
  • Trello
  • Zendesk
id
string

The unique identifier for a priority

name
string

The name of the priority

languages
string[]

Languages of the ticket

Supported in
  • Gorgias
is_unread
boolean

Whether the ticket is unread

Supported in
  • Gorgias
source
object
id
string

The unique identifier for a source

name
string

The name of the source

remote_data
object

Raw data returned from the remote API call.