Skip to main content
POST
/
tickets
Create a ticket
curl --request POST \
  --url https://core.ravenna.ai/api/tickets \
  --header 'Content-Type: application/json' \
  --header 'x-ravenna-api-token: <api-key>' \
  --data '{
  "approvers": [
    {
      "id": "<string>"
    }
  ],
  "publishedAt": "<string>",
  "assignedAt": "<string>",
  "assigneeId": "<string>",
  "authorId": "<string>",
  "code": "<string>",
  "customFields": "<any>",
  "assignedAIAgent": "<string>",
  "description": "<string>",
  "disableAIResponse": true,
  "dueAt": "<string>",
  "followers": [
    {
      "id": "<string>"
    }
  ],
  "id": "<string>",
  "number": 123,
  "parentId": "<string>",
  "priority": "URGENT",
  "private": true,
  "published": true,
  "queueId": "<string>",
  "requesterId": "<string>",
  "requestTypeId": "<string>",
  "resolvedAt": "<string>",
  "slackChannelId": "<string>",
  "slackThreads": [
    {
      "id": "<string>"
    }
  ],
  "snoozeUntil": "<string>",
  "source": "WEB",
  "integrationId": "<string>",
  "statusId": "<string>",
  "tags": [
    {
      "id": "<string>"
    }
  ],
  "title": "<string>",
  "metadata": "<any>"
}'
{
  "id": "<string>",
  "publishedAt": "<string>",
  "assignedAt": "<string>",
  "closedAt": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "requestType": {
    "id": "<string>",
    "name": "<string>",
    "isPrivate": true
  },
  "assigneeId": "<string>",
  "shortId": "<string>",
  "authorId": "<string>",
  "code": "<string>",
  "private": true,
  "description": "<string>",
  "dueAt": "<string>",
  "followers": [
    {
      "id": "<string>"
    }
  ],
  "approvers": [
    {
      "id": "<string>"
    }
  ],
  "approvedAt": "<string>",
  "declinedAt": "<string>",
  "number": 123,
  "priority": "URGENT",
  "shares": [
    {
      "id": "<string>",
      "queueId": "<string>",
      "queue": {
        "workspaceId": "<string>",
        "name": "<string>",
        "emoji": "<string>"
      },
      "ticketId": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ],
  "published": true,
  "queueId": "<string>",
  "requesterId": "<string>",
  "resolvedAt": "<string>",
  "assignedAIAgent": "<string>",
  "startAt": "<string>",
  "snoozeUntil": "<string>",
  "respondedAt": "<string>",
  "slackChannelId": "<string>",
  "archivedAt": "<string>",
  "lastAgentResponse": "<string>",
  "agentParticipated": true,
  "slackChannel": {
    "appId": "<string>",
    "channelId": "<string>",
    "channelName": "<string>"
  },
  "slackThreads": [
    {
      "id": "<string>",
      "type": "DM",
      "userId": "<string>",
      "appId": "<string>",
      "channelId": "<string>",
      "messageTs": "<string>",
      "mirrorTs": "<string>",
      "ticketId": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ],
  "source": "WEB",
  "statusId": "<string>",
  "status": {
    "id": "<string>",
    "label": "<string>",
    "order": 123,
    "system": true,
    "statusGroupId": "<string>",
    "statusGroup": {
      "id": "<string>",
      "label": "<string>",
      "workspaceId": "<string>"
    },
    "requestTypes": [
      {
        "id": "<string>",
        "requestTypeId": "<string>"
      }
    ],
    "createdAt": "<string>",
    "updatedAt": "<string>"
  },
  "tags": [
    {
      "id": "<string>",
      "name": "<string>",
      "color": "tomato",
      "aiGenerated": true,
      "workspaceId": "<string>",
      "description": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ],
  "stars": [
    {
      "userId": "<string>"
    }
  ],
  "queue": {
    "id": "<string>",
    "name": "<string>",
    "workspaceId": "<string>",
    "workspace": {
      "id": "<string>",
      "slug": "<string>"
    },
    "prefix": "<string>",
    "emoji": "<string>",
    "system": true,
    "settings": {
      "id": "<string>",
      "aiEnabled": true,
      "respondOnMessage": "<string>",
      "respondOnMention": true,
      "allowInboundEmails": true,
      "autoCreateTickets": true,
      "autoClassify": true,
      "autoTag": true,
      "enableUserActions": true,
      "enableUserEmojis": true,
      "enableCSAT": true,
      "enableEmojiUpdates": true,
      "sendAllTicketToTriageChannel": true,
      "enableGranularSlackNotifications": true,
      "negativeFeedbackAutoCreate": true,
      "allowGuestUsers": true,
      "silentMode": true,
      "whitelistedInboundEmails": [
        "<string>"
      ],
      "whitelistedInboundDomains": [
        "<string>"
      ],
      "emailSenderName": "<string>",
      "sendBouncedEmails": true,
      "showSlackPriority": true,
      "showSlackRequester": true,
      "showSlackAssignee": true
    },
    "slackChannels": [
      {
        "id": "<string>"
      }
    ],
    "requestTypes": [
      {
        "id": "<string>",
        "name": "<string>",
        "emoji": "<string>",
        "color": "<string>",
        "description": "<string>",
        "icon": "<string>"
      }
    ],
    "autoAssignees": [
      {
        "id": "<string>"
      }
    ],
    "_count": {
      "tickets": 123
    },
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "deletedAt": "<string>"
  },
  "originalQueueId": "<string>",
  "title": "<string>",
  "requestTypeId": "<string>",
  "csat": [
    {
      "id": "<string>",
      "score": 3,
      "feedback": "<string>",
      "userId": "<string>",
      "ticketId": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ],
  "disableAIResponse": true,
  "customFields": "<any>",
  "parentId": "<string>",
  "parent": {
    "id": "<string>",
    "number": 123,
    "queue": {
      "id": "<string>",
      "prefix": "<string>"
    }
  },
  "children": [
    {
      "id": "<string>",
      "title": "<string>",
      "description": "<string>",
      "number": 123,
      "statusId": "<string>",
      "legacyStatus": "OPEN",
      "requestTypeId": "<string>",
      "priority": "URGENT",
      "queueId": "<string>",
      "assigneeId": "<string>",
      "queue": {
        "id": "<string>",
        "name": "<string>",
        "workspaceId": "<string>",
        "workspace": {
          "id": "<string>",
          "slug": "<string>"
        },
        "prefix": "<string>",
        "emoji": "<string>",
        "system": true,
        "settings": {
          "id": "<string>",
          "aiEnabled": true,
          "respondOnMessage": "<string>",
          "respondOnMention": true,
          "allowInboundEmails": true,
          "autoCreateTickets": true,
          "autoClassify": true,
          "autoTag": true,
          "enableUserActions": true,
          "enableUserEmojis": true,
          "enableCSAT": true,
          "enableEmojiUpdates": true,
          "sendAllTicketToTriageChannel": true,
          "enableGranularSlackNotifications": true,
          "negativeFeedbackAutoCreate": true,
          "allowGuestUsers": true,
          "silentMode": true,
          "whitelistedInboundEmails": [
            "<string>"
          ],
          "whitelistedInboundDomains": [
            "<string>"
          ],
          "emailSenderName": "<string>",
          "sendBouncedEmails": true,
          "showSlackPriority": true,
          "showSlackRequester": true,
          "showSlackAssignee": true
        },
        "slackChannels": [
          {
            "id": "<string>"
          }
        ],
        "requestTypes": [
          {
            "id": "<string>",
            "name": "<string>",
            "emoji": "<string>",
            "color": "<string>",
            "description": "<string>",
            "icon": "<string>"
          }
        ],
        "autoAssignees": [
          {
            "id": "<string>"
          }
        ],
        "_count": {
          "tickets": 123
        },
        "createdAt": "<string>",
        "updatedAt": "<string>",
        "deletedAt": "<string>"
      }
    }
  ]
}

Authorizations

​
x-ravenna-api-token
string
header
required

Body

application/json
​
priority
enum<string>
required
Available options:
URGENT,
HIGH,
MEDIUM,
LOW
​
title
string
required
Minimum length: 1
​
approvers
object[]
​
publishedAt

Date field that accepts Date objects, ISO 8601 strings, or null

​
assignedAt

Date field that accepts Date objects, ISO 8601 strings, or null

​
assigneeId
string | null
​
authorId
string | null
​
code
string | null
​
customFields
any
​
assignedAIAgent
string | null
​
description
string | null
​
disableAIResponse
boolean
​
dueAt

Date field that accepts Date objects, ISO 8601 strings, or null

​
followers
object[]
​
id
string
​
number
number
​
parentId
string | null
​
private
boolean
​
published
boolean
​
queueId
string
​
requesterId
string | null
​
requestTypeId
string | null
​
resolvedAt

Date field that accepts Date objects, ISO 8601 strings, or null

​
slackChannelId
string | null
​
slackThreads
object[]
​
snoozeUntil

Date field that accepts Date objects, ISO 8601 strings, or null

​
source
enum<string> | null
Available options:
WEB,
EMAIL,
FORM,
SLACK,
SLA,
WORKFLOW,
JIRA,
INTEGRATION
​
integrationId
string | null
​
statusId
string | null
​
tags
object[]
​
metadata
any

Response

Successful response

​
id
string
required
​
publishedAt
string | null
required
​
assignedAt
string | null
required
​
closedAt
string | null
required
​
createdAt
string
required
​
updatedAt
string
required
​
requestType
object | null
required
​
assigneeId
string | null
required
​
shortId
string
required
​
authorId
string | null
required
​
code
string | null
required
​
private
boolean
required
​
description
string | null
required
​
dueAt
string | null
required
​
followers
object[]
required
​
approvers
object[]
required
​
approvedAt
string | null
required
​
declinedAt
string | null
required
​
number
number | null
required
​
priority
enum<string>
required
Available options:
URGENT,
HIGH,
MEDIUM,
LOW
​
shares
object[]
required
​
published
boolean
required
​
queueId
string
required
​
requesterId
string | null
required
​
resolvedAt
string | null
required
​
assignedAIAgent
string | null
required
​
startAt
string | null
required
​
snoozeUntil
string | null
required
​
respondedAt
string | null
required
​
slackChannelId
string | null
required
​
archivedAt
string | null
required
​
lastAgentResponse
string | null
required
​
agentParticipated
boolean | null
required
​
slackChannel
object | null
required
​
slackThreads
object[]
required
​
source
enum<string> | null
required
Available options:
WEB,
EMAIL,
FORM,
SLACK,
SLA,
WORKFLOW,
JIRA,
INTEGRATION
​
statusId
string | null
required
​
status
object | null
required
​
tags
object[]
required
​
stars
object[]
required
​
queue
object
required
​
originalQueueId
string | null
required
​
title
string
required
​
requestTypeId
string | null
required
​
csat
object[]
required
​
disableAIResponse
boolean
required
​
customFields
any
required
​
parentId
string | null
required
​
parent
object | null
required
​
children
object[]
required
⌘I