API Reference
/
Connector API
/
Ticketing
/
Create Comment

Connector API

The Synqly Connector APIs provide a unifying interface and data model for all supported service Providers.

See the Synqly Overview for more information.

Download OpenAPI description
connectors.json
connectors.yaml
Languages
Servers
Synqly
https://api.synqly.com/

Assets

Operations

Edr

Operations

Hooks

Operations

Identity

Operations

Notifications

Operations

Operations (In Development)

In Development

This feature is actively being developed. Breaking changes should be expected.

Please contact us before using this feature.

Operations

Siem

Operations

Sink

Operations

Storage

Operations

Ticketing

Operations

List Comments

Request

Lists all comments for the ticket matching {ticketId} from the token-linked Integration.

Path
ticketIdstring(Id)required
curl -i -X GET \
  'https://api.synqly.com/v1/ticketing/tickets/{ticketId}/comments' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
resultArray of objects(Comment)required
result[].​idstring(Id)required
result[].​ticket_idstring(Id)required
result[].​creatorstringrequired

The user who created the comment.

result[].​contentstringrequired

The content of the comment formatted as markdown.

result[].​created_atstring(date-time)required

The date the comment was created.

result[].​updated_atstring or null(date-time)

The date the comment was last updated.

result[].​unmappedobject(Object)

The Object type is used to represent an object with arbitrary fields. The keys are strings and the values are any type.

cursorstringrequired

Cursor to use to retrieve the next page of results

metaobject(MetaResponse)
Response
application/json
{
  "result": [
    { … }
  ],
  "cursor": "string",
  "meta": {
    "stats": { … },
    "api": { … }
  }
}

Create Comment

Request

Creates a comment on the ticket matching {ticketId} from the token-linked Integration.

Path
ticketIdstring(Id)required
Bodyapplication/jsonrequired
contentstringrequired

The content of the comment.

creatorstring or null

Email address of user who created this ticket. Required by PagerDuty. Not supported by Jira, ServiceNow, or Torq.

curl -i -X POST \
  'https://api.synqly.com/v1/ticketing/tickets/{ticketId}/comments' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "creator": "string",
    "content": "string"
  }'

Responses

Bodyapplication/json
resultobject(Comment)required

Comment on a ticket.

result.​idstring(Id)required
result.​ticket_idstring(Id)required
result.​creatorstringrequired

The user who created the comment.

result.​contentstringrequired

The content of the comment formatted as markdown.

result.​created_atstring(date-time)required

The date the comment was created.

result.​updated_atstring or null(date-time)

The date the comment was last updated.

result.​unmappedobject(Object)

The Object type is used to represent an object with arbitrary fields. The keys are strings and the values are any type.

metaobject(MetaResponse)
Response
application/json
{
  "result": {
    "id": "string",
    "ticket_id": "string",
    "creator": "string",
    "content": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "unmapped": {}
  },
  "meta": {
    "stats": { … },
    "api": { … }
  }
}

Delete Comment

Request

Deletes the comment matching {commentId} form the ticket matching {ticketId} from the token-linked Integration.

Path
ticketIdstring(Id)required
commentIdstring(Id)required
curl -i -X DELETE \
  'https://api.synqly.com/v1/ticketing/tickets/{ticketId}/comments/{commentId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Response
No content

Vulnerabilities

Operations