> ## Documentation Index
> Fetch the complete documentation index at: https://docs.yume.cloud/llms.txt
> Use this file to discover all available pages before exploring further.

# Get endpoints



## OpenAPI

````yaml /openapi/webhooks.json get /v1/webhooks/endpoints/
openapi: 3.0.3
info:
  title: Yume API — Вебхуки
  version: 1.0.0
  description: Подписки на события и доставка вебхуков.
servers:
  - url: https://api.yume.cloud
    description: Production
  - url: https://api.stage.yume.cloud
    description: Stage
security: []
paths:
  /v1/webhooks/endpoints/:
    get:
      tags:
        - endpoints
      summary: Get endpoints
      operationId: endpoints_list
      parameters:
        - $ref: '#/components/parameters/TenantId'
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/WebhookEndpoint'
          description: ''
      security:
        - jwtAuth: []
components:
  parameters:
    TenantId:
      name: X-Tenant-Id
      in: header
      required: false
      schema:
        type: integer
      description: >-
        Компания, в контексте которой выполняется запрос — её id из `GET
        /v1/tenant/`. Пользователь должен состоять в этой компании: чужой id
        доступа к данным не даёт. Без заголовка компания определяется по домену
        запроса.
  schemas:
    WebhookEndpoint:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        name:
          type: string
          title: Название
          maxLength: 255
        url:
          type: string
          format: uri
          title: Адрес
          maxLength: 1024
        method:
          allOf:
            - $ref: '#/components/schemas/MethodEnum'
          title: Способ
        modules:
          type: array
          items:
            $ref: '#/components/schemas/ModulesEnum'
          title: Модули
        events:
          type: array
          items:
            $ref: '#/components/schemas/EventsEnum'
          title: Триггеры
        headers:
          title: Заголовки
        timeout:
          type: integer
          maximum: 30
          minimum: 1
          title: Таймаут
        max_retries:
          type: integer
          maximum: 10
          minimum: 0
          title: Повторы
        active:
          type: boolean
          title: Активна
        failure_count:
          type: integer
          maximum: 2147483647
          minimum: 0
        last_success_at:
          type: string
          format: date-time
          nullable: true
        last_failure_at:
          type: string
          format: date-time
          nullable: true
        disabled_at:
          type: string
          format: date-time
          nullable: true
        secret_hint:
          type: string
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
          title: Создан
        updated_at:
          type: string
          format: date-time
          readOnly: true
          title: Обновлен
      required:
        - created_at
        - id
        - secret_hint
        - updated_at
        - url
    MethodEnum:
      enum:
        - POST
        - PUT
        - PATCH
      type: string
      description: |-
        * `POST` - POST
        * `PUT` - PUT
        * `PATCH` - PATCH
    ModulesEnum:
      enum:
        - order
        - product
        - system
      type: string
      description: |-
        * `order` - Аренды
        * `product` - Продукты
        * `system` - Система
    EventsEnum:
      enum:
        - order.created
        - order.status_changed
        - order.price_changed
        - order.inventory_changed
        - order.updated
        - order.deleted
        - product.created
        - product.price_changed
        - product.published_changed
        - product.tariff_changed
        - product.component_changed
        - product.updated
        - product.deleted
        - webhook.ping
      type: string
      description: |-
        * `order.created` - Аренда создана
        * `order.status_changed` - Статус аренды изменён
        * `order.price_changed` - Сумма аренды изменена
        * `order.inventory_changed` - Состав аренды изменён
        * `order.updated` - Аренда изменена
        * `order.deleted` - Аренда удалена
        * `product.created` - Продукт создан
        * `product.price_changed` - Цена продукта изменена
        * `product.published_changed` - Публикация продукта изменена
        * `product.tariff_changed` - Тарифы продукта изменены
        * `product.component_changed` - Состав продукта изменён
        * `product.updated` - Продукт изменён
        * `product.deleted` - Продукт удалён
        * `webhook.ping` - Тестовое событие
  securitySchemes:
    jwtAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````