> ## 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 deliveries



## OpenAPI

````yaml /openapi/webhooks.json get /v1/webhooks/deliveries/
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/deliveries/:
    get:
      tags:
        - deliveries
      summary: Get deliveries
      operationId: deliveries_list
      parameters:
        - in: query
          name: created_at__gte
          schema:
            type: string
            format: date-time
        - in: query
          name: created_at__lte
          schema:
            type: string
            format: date-time
        - in: query
          name: endpoint
          schema:
            type: number
        - in: query
          name: event
          schema:
            type: array
            items:
              type: string
              enum:
                - order.created
                - order.deleted
                - order.inventory_changed
                - order.price_changed
                - order.status_changed
                - order.updated
                - product.component_changed
                - product.created
                - product.deleted
                - product.price_changed
                - product.published_changed
                - product.tariff_changed
                - product.updated
                - webhook.ping
          description: Несколько значений могут быть разделены запятыми.
          explode: false
          style: form
        - in: query
          name: module
          schema:
            type: string
            enum:
              - order
              - product
              - system
          description: |-
            * `order` - Аренды
            * `product` - Продукты
            * `system` - Система
        - in: query
          name: object_id
          schema:
            type: integer
        - name: page
          required: false
          in: query
          description: A page number within the paginated result set.
          schema:
            type: integer
        - name: pageSize
          required: false
          in: query
          description: Number of results to return per page.
          schema:
            type: integer
        - in: query
          name: status
          schema:
            type: string
            enum:
              - failed
              - pending
              - retrying
              - success
          description: |-
            * `pending` - Ожидает
            * `retrying` - Повтор
            * `success` - Успешно
            * `failed` - Ошибка
        - $ref: '#/components/parameters/TenantId'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedWebhookDeliveryList'
          description: ''
      security:
        - jwtAuth: []
components:
  parameters:
    TenantId:
      name: X-Tenant-Id
      in: header
      required: false
      schema:
        type: integer
      description: >-
        Компания, в контексте которой выполняется запрос — её id из `GET
        /v1/tenant/`. Пользователь должен состоять в этой компании: чужой id
        доступа к данным не даёт. Без заголовка компания определяется по домену
        запроса.
  schemas:
    PaginatedWebhookDeliveryList:
      type: object
      required:
        - count
        - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/WebhookDelivery'
    WebhookDelivery:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        endpoint:
          type: integer
        event:
          $ref: '#/components/schemas/EventEnum'
        module:
          $ref: '#/components/schemas/ModuleEnum'
        object_id:
          type: integer
          maximum: 9223372036854776000
          minimum: -9223372036854776000
          format: int64
          nullable: true
        status:
          $ref: '#/components/schemas/StatusEnum'
        attempt:
          type: integer
          maximum: 32767
          minimum: 0
        status_code:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
          nullable: true
        duration_ms:
          type: integer
          maximum: 2147483647
          minimum: 0
          nullable: true
        error:
          type: string
        response:
          type: string
        delivered_at:
          type: string
          format: date-time
          nullable: true
        created_at:
          type: string
          format: date-time
          readOnly: true
          title: Создан
        updated_at:
          type: string
          format: date-time
          readOnly: true
          title: Обновлен
      required:
        - created_at
        - endpoint
        - event
        - id
        - module
        - updated_at
    EventEnum:
      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` - Тестовое событие
    ModuleEnum:
      enum:
        - order
        - product
        - system
      type: string
      description: |-
        * `order` - Аренды
        * `product` - Продукты
        * `system` - Система
    StatusEnum:
      enum:
        - pending
        - retrying
        - success
        - failed
      type: string
      description: |-
        * `pending` - Ожидает
        * `retrying` - Повтор
        * `success` - Успешно
        * `failed` - Ошибка
  securitySchemes:
    jwtAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````