Skip to main content
POST
/
integrations
/
github
/
{conversation_id}
/
tickets
Create a new GitHub issue and attach it to a conversation
curl --request POST \
  --url https://api.getfernand.com/integrations/github/{conversation_id}/tickets \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "title": "Fix login authentication bug",
  "repository": "R_kgDOABCDEF"
}
'
{
  "id": "I_kwDOABCDEF",
  "number": 42,
  "title": "Fix login authentication bug",
  "url": "https://github.com/piedpiper/www/issues/42",
  "state_reason": null,
  "updated_at": "2024-01-15T10:30:00Z",
  "closed_at": null,
  "assignee": {
    "id": "U_kgDOABCDEF",
    "login": "richard.hendricks",
    "name": "Richard H.",
    "avatar_url": "https://avatars.githubusercontent.com/u/123456"
  },
  "labels": [
    {
      "id": "LA_kwDOABCDEF",
      "name": "bug",
      "color": "d73a4a"
    }
  ],
  "type": {
    "id": "IT_kwDOABCDEF",
    "name": "Bug",
    "color": "d73a4a"
  }
}
Creates a new GitHub issue with the provided details and automatically attaches it to the specified conversation. The issue is created in the specified repository. A comment is added to the issue with a link to the related conversation in Fernand.

Authorizations

X-API-Key
string
header
required

Authenticate your account by including your secret key in API requests. You can manage your API keys in the Dashboard.

Authentication to the API is performed by using the HTTP Header X-API-Key.

Path Parameters

conversation_id
integer
required

ID of the conversation to attach the issue to.

Body

application/json
title
string
required

Title of the GitHub issue (required, max 250 characters).

Example:

"Fix login authentication bug"

repository
string
required

ID of the repository to create the issue in (required).

Example:

"R_kgDOABCDEF"

description
string

Description/body of the issue (optional, max 250,000 characters).

Example:

"Users are unable to log in with their credentials. The authentication service returns a 500 error."

assignee
string

ID of the user to assign the issue to (optional).

Example:

"U_kgDOABCDEF"

milestone
string

ID of the milestone to associate the issue with (optional).

Example:

"M_kwDOABCDEF"

type
string

ID of the issue type (optional).

Example:

"IT_kwDOABCDEF"

labels
string[]

Array of label IDs to apply to the issue (optional).

Example:
["LA_kwDOABCDEF", "LA_kwDOXYZ123"]
projects
string[]

Array of project IDs to add the issue to (optional).

Example:
["PVT_kwDOABCDEF"]

Response

GitHub issue created and attached successfully.

id
string

Unique identifier of the created GitHub issue.

Example:

"I_kwDOABCDEF"

number
integer

Issue number within the repository.

Example:

42

title
string

Title of the issue.

Example:

"Fix login authentication bug"

url
string

URL to view the issue on GitHub.

Example:

"https://github.com/piedpiper/www/issues/42"

state_reason
string

Reason for the current state (null for newly created issues).

Example:

null

updated_at
string

ISO 8601 timestamp of last update.

Example:

"2024-01-15T10:30:00Z"

closed_at
string

ISO 8601 timestamp when the issue was closed (null for open issues).

Example:

null

assignee
object

Assigned user (null if unassigned).

labels
object[]

List of labels applied to the issue.

type
object

Issue type (null if no type is set).