Suptask
Suptask Web AppSignup for FREE
  • Welcome
  • Getting Started
    • Install Suptask
      • Slack permission scopes
      • Invite the Suptask App
    • Your first Inbox & Form
    • Ticket submission
    • Manage and Reply on tickets
    • Key concepts
    • User Guides
      • Ticketing as an Agent
      • Ticketing as a User
      • Rollout and Onboarding guide
    • FAQ & Troubleshooting
    • Contact Support
    • Videos
  • Setup & Configure
    • Inboxes
      • Inboxes
      • Users and Agents in the same channel
      • Service Level Agreements (SLA)
      • Agent Work Hours
      • Automatically create tickets from new messages
      • Migrate to the new generation
    • Forms & Fields
      • Forms
      • Custom Fields
      • Default Fields
      • Custom Statuses
      • Tags
      • Using the Organization field
    • Users & Permissions
    • Slack External Connections
    • Multiple Slack Workspaces
      • Multiple Workspaces & Slack Community
      • Enterprise Grid
    • Branding & White-labeling
    • Language & Translations
  • Working with tickets
    • For Agents: who respond and manage tickets
      • Overview and manage tickets as an Agent
      • Responding to tickets
      • Move or Escalate to another Inbox
      • Submit tickets on behalf of a user
      • Request and manage Approvals
      • Customer Satisfaction Score (CSAT)
      • Templated answers with Canned Replies
      • AI Assistant
      • Followers
      • Delete tickets
    • For Users: who submit tickets
      • How to submit a ticket
      • Overview your tickets as a user
    • Overview & Analytics
      • Overview and track tickets
      • Dashboard
      • Reports
    • Essentials for Your daily work
      • Tickets Summary Notifications
      • Setup one-click emoji reactions
      • How to search for tickets
      • Display Suptask in Slack
  • Integrations, Automations & Workflows
    • Introduction to Integrations
    • List of integrations
    • Integration guides
      • Slack Workflows
      • WhatsApp
      • JIRA Software
      • Zendesk
      • ClickUp
      • Notion
      • Google Sheets
      • Suptask API
      • WebHooks
      • Export API
      • Integrate with other Slack Apps
      • External issue & ticketing systems
        • Create tickets from Suptask to GitLab
        • Create tickets from Suptask to GitHub
        • Create tickets from Suptask to JIRA
    • Email-to-Slack Ticketing
      • Email-to-Slack Ticketing
      • Gmail & Google Workspaces
      • Microsoft Outlook
      • AI Email routing
    • On-call rotation
    • Automations in Suptask
  • Account Management
    • Account Settings
    • Subscription & Billing
      • Subscription & Billing
      • Integrations billing
      • Limitations in the Free plan
Powered by GitBook
On this page

Was this helpful?

Export as PDF
  1. Integrations, Automations & Workflows
  2. Integration guides

Suptask API

Learn how to use and integrate with the Suptask API

PreviousGoogle SheetsNextWebHooks

Last updated 2 months ago

Was this helpful?

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.


Request API access

The API requires a valid API token in order to authenticate to 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

Retrieve the user Slack member ID

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

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

Suptask Support
Manage fields
Retrieve the Slack member ID of a user.

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

  • Overview
  • API Definition
  • POSTCreate a new ticket
  • PATCHUpdate an existing ticket
  • DELETEDelete a ticket
  • POSTCreate or associate an external ticket
  • POSTPost a new reply to a ticket
  • Request API access
  • How to retrieve values for the API

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

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"
}