Tickets | API Documentation | Heeler User Guide

Get Jira Connections

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful Response

application/json

connection_idintegerRequired

namestringRequired

404

Not found

get

/api/tickets/jira/connections

GET /api/tickets/jira/connections HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "connection_id": 1,
    "name": "text"
  }
]

Get Jira Projects

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

connection_idintegerRequired

Responses

200

Successful Response

application/json

project_keystringRequired

namestringRequired

404

Not found

422

Validation Error

application/json

get

/api/tickets/jira/{connection_id}/projects

GET /api/tickets/jira/{connection_id}/projects HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "project_key": "text",
    "name": "text"
  }
]

Get Jira Issue Fields

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

connection_idintegerRequired

project_keystringRequired

Query parameters

issue_type_idany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Generic form field model for dynamic form generation in the frontend.

idstringRequired

namestringRequired

typestring · enumRequiredPossible values:

allowed_valuesany ofRequired

or

nullOptional

use_autocompletebooleanOptionalDefault: false

requiredbooleanRequired

multilinebooleanOptionalDefault: false

default_valueany ofOptional

anyOptional

or

nullOptional

404

Not found

422

Validation Error

application/json

get

/api/tickets/jira/{connection_id}/projects/{project_key}/fields

GET /api/tickets/jira/{connection_id}/projects/{project_key}/fields HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "text",
    "name": "text",
    "type": "array",
    "allowed_values": [
      {
        "id": "text",
        "value": "text"
      }
    ],
    "use_autocomplete": false,
    "required": true,
    "multiline": false,
    "default_value": null
  }
]

List Jira Tickets

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

connection_idintegerRequired

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

/api/tickets/jira/{connection_id}/tickets

GET /api/tickets/jira/{connection_id}/tickets HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "issues": [
    {
      "issue_id": 1,
      "name": "text",
      "status": "text",
      "status_category": "text",
      "issue_type": "text",
      "issue_type_icon_url": "text",
      "url": "text",
      "summary": "text",
      "connection_type": "jira",
      "remediation_id": 1
    }
  ]
}

Search Jira Issues

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

connection_idintegerRequired

Query parameters

searchstringRequired

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

/api/tickets/jira/{connection_id}/search

GET /api/tickets/jira/{connection_id}/search?search=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "issues": [
    {
      "issue_id": 1,
      "name": "text",
      "status": "text",
      "status_category": "text",
      "issue_type": "text",
      "issue_type_icon_url": "text",
      "url": "text",
      "summary": "text",
      "connection_type": "jira",
      "remediation_id": 1
    }
  ]
}

Create Jira Issue

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

connection_idintegerRequired

project_idstringRequired

issue_typestringRequired

labelsany ofOptional

string[]Optional

or

nullOptional

Responses

200

Successful Response

application/json

issue_idintegerRequired

namestringRequired

statusstringRequired

status_categorystringRequired

issue_typestringRequired

issue_type_icon_urlany ofRequired

stringOptional

or

nullOptional

urlany ofRequired

stringOptional

or

nullOptional

summarystringRequired

connection_typestringOptionalDefault: jira

remediation_idany ofOptional

integerOptional

or

nullOptional

404

Not found

422

Validation Error

application/json

post

/api/tickets/jira

POST /api/tickets/jira HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 125

{
  "connection_id": 1,
  "project_id": "text",
  "issue_type": "text",
  "fields": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "labels": [
    "text"
  ]
}

{
  "issue_id": 1,
  "name": "text",
  "status": "text",
  "status_category": "text",
  "issue_type": "text",
  "issue_type_icon_url": "text",
  "url": "text",
  "summary": "text",
  "connection_type": "jira",
  "remediation_id": 1
}

Get Linear Connections

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful Response

application/json

connection_idintegerRequired

namestringRequired

404

Not found

get

/api/tickets/linear/connections

GET /api/tickets/linear/connections HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "connection_id": 1,
    "name": "text"
  }
]

Create Linear Issue

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

connection_idintegerRequired

team_idstringRequired

Responses

200

Successful Response

application/json

issue_idintegerRequired

namestringRequired

statusstringRequired

status_categorystringRequired

issue_typestringRequired

issue_type_icon_urlany ofRequired

stringOptional

or

nullOptional

urlany ofRequired

stringOptional

or

nullOptional

summarystringRequired

connection_typestringOptionalDefault: jira

remediation_idany ofOptional

integerOptional

or

nullOptional

404

Not found

422

Validation Error

application/json

post

/api/tickets/linear

POST /api/tickets/linear HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 84

{
  "connection_id": 1,
  "team_id": "text",
  "fields": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "issue_id": 1,
  "name": "text",
  "status": "text",
  "status_category": "text",
  "issue_type": "text",
  "issue_type_icon_url": "text",
  "url": "text",
  "summary": "text",
  "connection_type": "jira",
  "remediation_id": 1
}

Get Linear Teams

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

connection_idintegerRequired

Responses

200

Successful Response

application/json

team_idstringRequired

namestringRequired

404

Not found

422

Validation Error

application/json

get

/api/tickets/linear/{connection_id}/teams

GET /api/tickets/linear/{connection_id}/teams HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "team_id": "text",
    "name": "text"
  }
]

Get Linear Team Fields

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

connection_idintegerRequired

team_idstringRequired

Responses

200

Successful Response

application/json

Generic form field model for dynamic form generation in the frontend.

idstringRequired

namestringRequired

typestring · enumRequiredPossible values:

allowed_valuesany ofRequired

or

nullOptional

use_autocompletebooleanOptionalDefault: false

requiredbooleanRequired

multilinebooleanOptionalDefault: false

default_valueany ofOptional

anyOptional

or

nullOptional

404

Not found

422

Validation Error

application/json

get

/api/tickets/linear/{connection_id}/teams/{team_id}/fields

GET /api/tickets/linear/{connection_id}/teams/{team_id}/fields HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "text",
    "name": "text",
    "type": "array",
    "allowed_values": [
      {
        "id": "text",
        "value": "text"
      }
    ],
    "use_autocomplete": false,
    "required": true,
    "multiline": false,
    "default_value": null
  }
]

hashtagGet Jira Connections

hashtagGet Jira Projects

hashtagGet Jira Issue Fields

hashtagList Jira Tickets

hashtagSearch Jira Issues

hashtagCreate Jira Issue

hashtagGet Linear Connections

hashtagCreate Linear Issue

hashtagGet Linear Teams

hashtagGet Linear Team Fields

Get Jira Connections

Get Jira Projects

Get Jira Issue Fields

List Jira Tickets

Search Jira Issues

Create Jira Issue

Get Linear Connections

Create Linear Issue

Get Linear Teams

Get Linear Team Fields