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

# Get inbound webhook by id

> Gets a single inbound webhook by id. Intended for low-frequency operator use.



## OpenAPI

````yaml /pt/openapi/v3-current/indirect-pix.yaml get /v1/webhooks/inbound/{id}
openapi: 3.1.0
info:
  description: >-
    API for Pix Indirect via BTG. It covers DICT keys and claims; MED infraction
    reports, fraud markers, refund requests, and funds recoveries; DICT
    statistics and reconciliation; Pix transfers, refunds, and schedules; static
    QR codes and QR code decoding; immediate and due-date collections; Pix
    Automático for the payer; transaction reports and TemposTransacoes
    statistics; and inbound and outbound webhook records.
  title: Pix BTG API
  version: 1.12.0
servers:
  - url: https://api.example.com
    description: >-
      Replace the example host with the URL provided during environment
      onboarding.
security:
  - BearerAuth: []
paths:
  /v1/webhooks/inbound/{id}:
    get:
      tags:
        - Webhooks
      summary: Get inbound webhook by id
      description: >-
        Gets a single inbound webhook by id. Intended for low-frequency operator
        use.
      operationId: webhook-get-inbound
      parameters:
        - description: >-
            The authorization token. Important: This header is required only if
            your environment has the Access Manager plugin enabled.
          in: header
          name: Authorization
          schema:
            description: >-
              The authorization token. Important: This header is required only
              if your environment has the Access Manager plugin enabled.
            type: string
        - description: Inbound webhook id (UUID).
          in: path
          name: id
          required: true
          schema:
            description: Inbound webhook id (UUID).
            examples:
              - 019cf6ef-e418-7ced-80c0-7b9816faa798
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookInboundOutput'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LegacyErrorBody'
          description: Bad Request
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LegacyErrorBody'
          description: Internal Server Error
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LegacyErrorBody'
          description: Error
components:
  schemas:
    WebhookInboundOutput:
      additionalProperties: false
      properties:
        attemptCount:
          examples:
            - 0
          format: int64
          type: integer
        createdAt:
          examples:
            - '2026-05-21T12:00:00Z'
          format: date-time
          type: string
        entityType:
          examples:
            - DICT_CLAIM
          type: string
        errorMessage:
          examples:
            - timeout calling downstream
          type: string
        id:
          examples:
            - 019cf6ef-e418-7ced-80c0-7b9816faa798
          type: string
        lastAttemptAt:
          examples:
            - '2026-05-21T12:00:00Z'
          format: date-time
          type: string
        maxRetries:
          examples:
            - 3
          format: int64
          type: integer
        nextRetryAt:
          examples:
            - '2026-05-21T12:00:00Z'
          format: date-time
          type: string
        payload: {}
        processedAt:
          examples:
            - '2026-05-21T12:00:00Z'
          format: date-time
          type: string
        receivedAt:
          examples:
            - '2026-05-21T12:00:00Z'
          format: date-time
          type: string
        requestId:
          examples:
            - 560d59b9-3c74-46f8-be67-fee895b8e89e
          type: string
        source:
          examples:
            - BTG
          type: string
        status:
          enum:
            - RECEIVED
            - PROCESSING
            - SENT
            - FAILED
          examples:
            - RECEIVED
          type: string
        updatedAt:
          examples:
            - '2026-05-21T12:00:00Z'
          format: date-time
          type: string
      required:
        - id
        - requestId
        - entityType
        - source
        - status
        - attemptCount
        - maxRetries
        - receivedAt
        - createdAt
        - updatedAt
      type: object
    LegacyErrorBody:
      additionalProperties: false
      properties:
        fields:
          additionalProperties:
            type: string
          type: object
        headers:
          additionalProperties:
            type: string
          type: object
        message:
          type: string
        paths:
          additionalProperties:
            type: string
          type: object
        queryParams:
          additionalProperties:
            type: string
          type: object
        raw:
          type: string
        code:
          type: string
        title:
          type: string
      required:
        - code
        - title
        - message
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT bearer token issued by the identity provider.
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.