JetBrains Chats API

Chat and messaging operations

Documentation

Specifications

Schemas & Data

Other Resources

OpenAPI Specification

jetbrains-chats-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: JetBrains Hub REST Activities Chats API
  description: The JetBrains Hub REST API provides programmatic access to Hub, the centralized authentication and authorization service for JetBrains tools. It allows management of users, groups, projects, roles, permissions, and OAuth 2.0 services. Hub serves as the identity provider for YouTrack, TeamCity, and other connected JetBrains services.
  version: 2024.1.0
  contact:
    name: JetBrains
    url: https://www.jetbrains.com/help/youtrack/devportal/hub-rest-api-reference.html
  license:
    name: Proprietary
    url: https://www.jetbrains.com/legal/
servers:
- url: https://{instance}.youtrack.cloud/hub/api/rest
  description: Hub API (via YouTrack Cloud)
  variables:
    instance:
      default: myinstance
      description: Your instance name
security:
- bearerAuth: []
tags:
- name: Chats
  description: Chat and messaging operations
paths:
  /chats/channels:
    get:
      summary: JetBrains List Channels
      description: Returns a list of chat channels.
      operationId: listChannels
      tags:
      - Chats
      responses:
        '200':
          description: Successful response with channel list
  /chats/messages:
    post:
      summary: JetBrains Send Message
      description: Sends a message to a chat channel.
      operationId: sendMessage
      tags:
      - Chats
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Message sent successfully
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Permanent token or OAuth 2.0 Bearer Token