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

# List Inbound Webhooks

> List stored inbound webhooks (received from BTG). The `entity_type` query parameter is required.



## OpenAPI

````yaml en/openapi/v3-current/indirect-pix.yaml GET /v1/webhooks/inbound
openapi: 3.0.3
info:
  title: Plugin BR Pix Indirect - Complete API
  description: |
    Complete API for Brazilian Pix instant payment system including
    Pix key dictionary operations, QR code generation/decoding, transactions and
    transaction limits.
  version: 1.7.6
servers:
  - url: https://plugin-pix-indirect.api.lerian.net
security:
  - bearerAuth: []
paths:
  /v1/webhooks/inbound:
    get:
      tags:
        - Webhooks API
      summary: List Inbound Webhooks
      description: >-
        List stored inbound webhooks (received from BTG). The `entity_type`
        query parameter is required.
      parameters:
        - name: entity_type
          in: query
          description: Required. Inbound entity type. Uppercased server-side.
          schema:
            type: string
            enum:
              - DICT_CLAIM
              - DICT_REFUND
              - DICT_CID_FILE
              - INFRACTION_REPORT_V2
              - PIX_DOWNLOAD
              - PIX_PAYMENT
              - PIX_PAYMENT_INBOUND
              - PIX_REVERSAL
              - PIX_REVERSAL_INBOUND
        - name: status
          in: query
          description: Filter by status
          schema:
            type: string
            enum:
              - RECEIVED
              - PROCESSING
              - SENT
              - FAILED
        - name: request_id
          in: query
          description: Filter by original BTG clientRequestId
          schema:
            type: string
        - name: created_after
          in: query
          description: Filter rows with created_at >= this RFC3339 timestamp
          schema:
            type: string
        - name: created_before
          in: query
          description: Filter rows with created_at <= this RFC3339 timestamp
          schema:
            type: string
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/Page'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListInboundWebhooksOutput'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorFormat'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorFormat'
      security:
        - bearerAuth: []
components:
  parameters:
    Limit:
      name: limit
      in: query
      description: Maximum number of items per page.
      required: false
      example: 10
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 10
    Page:
      name: page
      in: query
      description: Page number for pagination.
      required: false
      example: 1
      schema:
        type: integer
        minimum: 1
        default: 1
  schemas:
    ListInboundWebhooksOutput:
      properties:
        items:
          items:
            $ref: '#/components/schemas/WebhookInboundOutput'
          type: array
        limit:
          type: integer
          example: 20
        page:
          type: integer
          example: 1
        totalItems:
          type: integer
          example: 42
      type: object
    ErrorFormat:
      type: object
      description: The response message error.
      required:
        - code
        - title
        - message
      properties:
        code:
          type: string
          description: A unique, stable identifier for the error.
        title:
          type: string
          description: A brief summary of the issue.
        message:
          type: string
          description: Detailed guidance for resolving the error.
    WebhookInboundOutput:
      properties:
        attemptCount:
          type: integer
          example: 0
        createdAt:
          example: '2026-05-21T12:00:00Z'
          format: date-time
          type: string
        entityType:
          example: DICT_CLAIM
          type: string
        errorMessage:
          example: timeout calling downstream
          type: string
        id:
          example: 019cf6ef-e418-7ced-80c0-7b9816faa798
          type: string
        lastAttemptAt:
          example: '2026-05-21T12:00:00Z'
          format: date-time
          type: string
        maxRetries:
          example: 3
          type: integer
        nextRetryAt:
          example: '2026-05-21T12:00:00Z'
          format: date-time
          type: string
        payload:
          type: object
        processedAt:
          example: '2026-05-21T12:00:00Z'
          format: date-time
          type: string
        receivedAt:
          example: '2026-05-21T12:00:00Z'
          format: date-time
          type: string
        requestId:
          example: 560d59b9-3c74-46f8-be67-fee895b8e89e
          type: string
        source:
          example: BTG
          type: string
        status:
          enum:
            - RECEIVED
            - PROCESSING
            - SENT
            - FAILED
          example: RECEIVED
          type: string
        updatedAt:
          example: '2026-05-21T12:00:00Z'
          format: date-time
          type: string
      type: object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````