> ## 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. # Listar Registros de Webhook > Use este endpoint para recuperar uma lista paginada de registros de webhook do tenant do chamador. Defina `enabled=true` para retornar apenas os registros habilitados. Segredos de assinatura nunca são incluídos nesta resposta. ## OpenAPI ````yaml pt/openapi/v3-current/ted.yaml get /v1/webhooks openapi: 3.0.3 info: title: API do Plugin de Transferência Bancária (TED) description: >- API completa para transferências bancárias brasileiras (TED OUT, TED IN, P2P) através da plataforma Lerian, incluindo iniciação de transferências, processamento, acompanhamento de status e cancelamento. version: 1.1.9 servers: - url: https://ted.sandbox.lerian.net description: Sandbox (placeholder — ainda não disponível para acesso público) security: - BearerAuth: [] - OAuth2ClientCredentials: - api - OAuth2Password: - api tags: - name: Transfers API description: Endpoints para iniciar, processar, acompanhar e cancelar transferências. - name: Webhooks description: >- Endpoints para registrar e gerenciar assinaturas de webhook com escopo de tenant para eventos de transferência. - name: Webhook DLQ description: >- Endpoints para inspecionar e reprocessar mensagens da dead-letter queue de webhooks. paths: /v1/webhooks: get: tags: - Webhooks summary: Listar Registros de Webhook description: >- Use este endpoint para recuperar uma lista paginada de registros de webhook do tenant do chamador. Defina `enabled=true` para retornar apenas os registros habilitados. Segredos de assinatura nunca são incluídos nesta resposta. operationId: listWebhooks parameters: - name: limit in: query required: false description: Número máximo de registros a retornar. schema: type: integer minimum: 1 maximum: 100 default: 50 - name: offset in: query required: false description: Número de registros a pular para paginação. schema: type: integer minimum: 0 default: 0 - name: enabled in: query required: false description: Quando true, retorna apenas os registros habilitados. schema: type: boolean responses: '200': description: Indica que os registros de webhook correspondentes são retornados. content: application/json: schema: $ref: '#/components/schemas/ListWebhooksResponse' examples: list: summary: Um registro retornado value: items: - id: 550e8400-e29b-41d4-a716-446655440000 name: Operations webhook endpointUrl: https://hooks.example.com/transfer-events enabled: true eventTypes: - transfer.completed createdAt: '2026-02-01T15:30:00Z' updatedAt: '2026-02-01T15:30:00Z' pagination: limit: 50 offset: 0 returned: 1 hasNextPage: false '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '503': $ref: '#/components/responses/ServiceUnavailable' components: schemas: ListWebhooksResponse: type: object required: - items - pagination properties: items: type: array items: $ref: '#/components/schemas/WebhookRegistrationResponse' pagination: $ref: '#/components/schemas/WebhookListPagination' WebhookRegistrationResponse: type: object required: - id - name - endpointUrl - enabled - createdAt - updatedAt properties: id: type: string format: uuid description: O identificador único do registro de webhook. example: 550e8400-e29b-41d4-a716-446655440000 name: type: string description: O nome legível por humanos do registro. example: Operations webhook endpointUrl: type: string format: uri description: O endpoint HTTPS que recebe as entregas de eventos. example: https://hooks.example.com/transfer-events enabled: type: boolean description: Se o registro está ativo. example: true eventTypes: type: array description: >- Os tipos de evento que este endpoint assina. Ausente quando o registro recebe todos os tipos de evento. items: type: string example: - transfer.completed createdAt: type: string format: date-time description: O timestamp de quando o registro foi criado. example: '2026-02-01T15:30:00Z' updatedAt: type: string format: date-time description: O timestamp da última atualização. example: '2026-02-01T15:30:00Z' WebhookListPagination: type: object required: - limit - offset - returned - hasNextPage properties: limit: type: integer description: Número máximo de registros solicitado. example: 50 offset: type: integer description: Número de registros pulados. example: 0 returned: type: integer description: Número de registros retornados nesta resposta. example: 25 hasNextPage: type: boolean description: Se existem mais registros além da página atual. example: false ErrorResponse: type: object required: - error properties: error: type: object required: - code - service - category - message - requestId properties: code: type: string description: >- O código de erro estável. Erros do plugin usam o formato `BTF-XXXX`; rejeições de negócio/autenticação do JD SPB repassam o código bruto do fornecedor literalmente (por exemplo, `AAC90`, `ACE95`, `DVE01`), e falhas de transporte no nível do JD expõem os marcadores sintéticos `TRANSPORT` ou `JD_MISSING_CODE`. Faça a correspondência com base neste valor, e não no status HTTP. example: BTF-0010 service: type: string description: O serviço ou domínio que produziu o erro. example: plugin category: type: string description: >- Categoria de erro legível por máquina usada para decisões de reprocessamento. enum: - deterministic - transient - rate_limit - plugin example: deterministic message: type: string description: Um resumo do erro legível por humanos. example: >- Transferências só podem ser iniciadas de segunda a sexta entre 06:30 e 17:00 horário de Brasília requestId: type: string description: O ID de correlação da requisição. Presente mesmo quando vazio. example: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f fields: type: object additionalProperties: true description: >- Metadados estruturados de validação ou reprocessamento quando disponíveis. Detalhes de validação em nível de campo, cabeçalho, caminho e consulta são todos retornados aqui. example: currentTime: '2026-02-01T18:30:00-03:00' operatingHours: Mon-Fri 06:30-17:00 UTC-3 responses: BadRequest: description: >- Indica que a requisição contém entrada inválida. Verifique os detalhes do campo para erros de validação específicos. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: invalidInput: summary: Validation error value: error: code: BTF-0001 service: plugin category: deterministic message: >- The request contains invalid fields. Check the field details below. requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f fields: recipientIspb: must be 8 digits amount: must be positive Unauthorized: description: Indica que a requisição não possui um token de autenticação válido. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: unauthorized: summary: Missing authorization value: error: code: BTF-0401 service: plugin category: deterministic message: Missing or invalid authentication token requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f Forbidden: description: >- Indica que o chamador está autenticado mas não tem permissão para esta operação, ou o tenant não está licenciado para este endpoint. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: notLicensed: summary: Tenant not licensed value: error: code: BTF-0403 service: plugin category: deterministic message: Tenant is not licensed to use this endpoint requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f permissionDenied: summary: Caller lacks permission value: error: code: BTF-0405 service: plugin category: deterministic message: Caller lacks permission for this resource requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f ServiceUnavailable: description: >- Indica que um serviço externo (CRM, JD SPB, Midaz ou Fees) está temporariamente indisponível. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: crmUnavailable: summary: CRM service down value: error: code: BTF-0502 service: crm category: transient message: >- Unable to validate account. The CRM service is temporarily unavailable. Try again later. requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f jdUnavailable: summary: JD SPB unavailable value: error: code: TRANSPORT service: jd_spb category: transient message: >- Unable to submit transfer. The JD SPB service is temporarily unavailable. Try again later. requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f midazUnavailable: summary: Midaz ledger unavailable value: error: code: BTF-2000 service: midaz category: transient message: >- Unable to process transfer. The Midaz ledger service is temporarily unavailable. Try again later. requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f feeServiceUnavailable: summary: Fee service unavailable (fail-closed mode) value: error: code: BTF-3000 service: fees category: transient message: >- Unable to calculate fee. The fee service is temporarily unavailable. Try again later. requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f dlqInspectorUnavailable: summary: DLQ inspector not configured value: error: code: BTF-9005 service: plugin category: deterministic message: DLQ inspector is not configured requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: JWT description: >- Autenticação por token JWT Bearer. O tenantId é derivado do token bearer ou do contexto de requisição autenticado e não é fornecido por meio do X-Organization-Id. OAuth2ClientCredentials: type: oauth2 flows: clientCredentials: tokenUrl: /v1/login/oauth/access_token scopes: api: Acesso à API de transferências TED OAuth2Password: type: oauth2 flows: password: tokenUrl: /v1/login/oauth/access_token scopes: api: Acesso à API de transferências TED ````