Suptask API

Learn how to use and integrate with the Suptask API

Overview

Suptask offers an open API that enables you to integrate programmatically and automate your ticketing process.

API Definition

Review the OpenAPI v3 definition below.

Create a new ticket

post

Authorizations

Body

descriptionstringRequired

A detailed description of the ticket.

Example: User has lost access to his account.

prioritystringOptional

The priority of the ticket.

Example: CRITICAL

statusstringOptional

The current status of the ticket.

Example: Open

assigneestring | nullableOptional

The user Slack member ID assigned to the ticket.

Example: U132FRJPTER

requesterstringOptional

The requester Slack member ID of the ticket.

Example: U073PBJPHGW

requesterChannelstringRequired

One of the Slack channel IDs which are assigned to form.

Example: C076K6Y74L1

tagsstring[] | nullableOptional

Tags associated with the ticket.

Example: bug

formIdstringRequired

Identifier UUID for the form used to submit the ticket. Fetched from the Web url when editing a form.

Example: 96d140f8-bd0f-4b46-a115-c19e090bb79c

Responses

201

Ticket successfully created

application/json

400

Invalid request payload

404

Ticket not found

500

Server error

post

POST /ticket HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 338

{
  "description": "User has lost access to his account.",
  "priority": "CRITICAL",
  "status": "Open",
  "assignee": "U132FRJPTER",
  "requester": "U073PBJPHGW",
  "customFields": [
    {
      "fieldId": "9682a666-b6b2-4f5e-833d-cb4430799317",
      "value": "High Business Impact"
    }
  ],
  "requesterChannel": "C076K6Y74L1",
  "tags": [
    "bug"
  ],
  "formId": "96d140f8-bd0f-4b46-a115-c19e090bb79c"
}

{
  "ticketId": "758e6b65-b4ec-4a03-a15a-9d44ac88e093"
}

Update an existing ticket

patch

Authorizations

Path parameters

ticketIdobjectRequired

The unique ID of the ticket to update.

Body

descriptionstringOptional

A detailed description of the ticket.

Example: Updated issue details.

prioritystring | nullableOptional

The priority of the ticket.

Example: Medium

statusstringOptional

The current status of the ticket.

Example: Closed

assigneestring | nullableOptional

The user Slack member ID assigned to the ticket.

Example: U132FRJPTER

requesterstringOptional

The requester Slack member ID of the ticket.

Example: U073PBJPHGW

requesterChannelstringOptional

One of the Slack channel IDs which are assigned to form.

Example: C076K6Y74L1

tagsstring[] | nullableOptional

Tags associated with the ticket.

Example: bug

Responses

200

Ticket successfully updated

400

Invalid request payload

404

Ticket not found

500

Server error

patch

PATCH /ticket/{ticketId} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 276

{
  "description": "Updated issue details.",
  "priority": "Medium",
  "status": "Closed",
  "assignee": "U132FRJPTER",
  "requester": "U073PBJPHGW",
  "customFields": [
    {
      "fieldId": "9682a666-b6b2-4f5e-833d-cb4430799317",
      "value": "High Business Impact"
    }
  ],
  "requesterChannel": "C076K6Y74L1",
  "tags": [
    "bug"
  ]
}

No content

Delete a ticket

delete

Authorizations

Path parameters

ticketIdstringRequired

The UUID of the ticket to delete.

Example: 758e6b65-b4ec-4a03-a15a-9d44ac88e093

Responses

200

Ticket successfully deleted

404

Ticket not found

500

Server error

delete

DELETE /ticket/{ticketId} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

No content

Create or associate an external ticket

post

Authorizations

Path parameters

ticketIdobjectRequired

The unique UUID of the Suptask ticket to associate with an external ticket.

Body

externalIdstringOptional

The ID of the external ticket.

Example: EXT-123

integrationTypestringOptional

The type of integration (e.g., "Jira", "Zendesk").

Example: Jira

urlstring · uriOptional

The URL of the external ticket.

Example: https://jira.example.com/browse/EXT-123

Responses

201

External ticket successfully associated

application/json

400

Invalid request payload

404

Ticket not found

500

Server error

post

POST /ticket/external/{ticketId} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 145

{
  "externalId": "EXT-123",
  "integrationType": "Jira",
  "url": "https://jira.example.com/browse/EXT-123",
  "data": {
    "team_ref": "H34211",
    "crm_id": "ID42298"
  }
}

{
  "success": true,
  "message": "External ticket associated successfully."
}

Post a new reply to a ticket

post

Authorizations

Path parameters

ticketIdobjectRequired

The unique UUID of the Suptask ticket.

Body

textstringOptional

The reply message text

Example: We are working on your ticket.

usernamestringOptional

The displayed username of the reply text.

Example: Greg McDonald

channelarrayOptional

Select between Requester (public reply) and/or Responder (internal comment reply) channel.

Example: ["requester", "responder"]

Responses

200

Returns

application/json

400

Invalid request payload

404

Suptask ticket not found

500

Server error

post

POST /ticket/reply/{ticketId} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 111

{
  "text": "We are working on your ticket.",
  "username": "Greg McDonald",
  "channel": "[\"requester\", \"responder\"]"
}

{
  "success": true,
  "message": "Reply message sent successfully"
}

Request API access

The API requires a valid API token in order to authenticate to the API.

Contact Suptask Support to retrieve your access token and get started with the API.

How to retrieve values for the API

Retrieve the Form ID

Retrieve the Form ID by opening up the Form from your Inbox and edit it. From the URL you can get the Form ID which is in a UUID format:

Retrieve the field ID

Every created field in your Suptask account have a unique ID that can be retrieved from the Manage fields page by editing the field. The field ID is in a UUID format and be retried from the URL:

Retrieve the user Slack member ID

Retrieve the Slack member ID of a user.

PreviousGoogle Sheets NextWebHooks

Last updated 3 months ago

Was this helpful?