> ## 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 Webhook Registrations > Use this endpoint to retrieve a paginated list of webhook registrations for the caller's tenant. Set `enabled=true` to return only enabled registrations. Signing secrets are never included in this response. ## OpenAPI ````yaml en/openapi/v3-current/ted.yaml get /v1/webhooks openapi: 3.0.3 info: title: Bank Transfer (TED) Plugin API description: >- Complete API for Brazilian bank transfers (TED OUT, TED IN, P2P) through the Lerian platform, including transfer initiation, processing, status tracking, and cancellation. version: 1.1.9 servers: - url: https://ted.sandbox.lerian.net description: Sandbox (placeholder — not yet available for public access) security: - BearerAuth: [] - OAuth2ClientCredentials: - api - OAuth2Password: - api tags: - name: Transfers API description: Endpoints for initiating, processing, tracking, and cancelling transfers. - name: Webhooks description: >- Endpoints for registering and managing tenant-scoped webhook subscriptions for transfer events. - name: Webhook DLQ description: Endpoints for inspecting and retrying webhook dead-letter queue messages. paths: /v1/webhooks: get: tags: - Webhooks summary: List Webhook Registrations description: >- Use this endpoint to retrieve a paginated list of webhook registrations for the caller's tenant. Set `enabled=true` to return only enabled registrations. Signing secrets are never included in this response. operationId: listWebhooks parameters: - name: limit in: query required: false description: Maximum number of registrations to return. schema: type: integer minimum: 1 maximum: 100 default: 50 - name: offset in: query required: false description: Number of registrations to skip for pagination. schema: type: integer minimum: 0 default: 0 - name: enabled in: query required: false description: When true, returns only enabled registrations. schema: type: boolean responses: '200': description: Indicates that the matching webhook registrations are returned. content: application/json: schema: $ref: '#/components/schemas/ListWebhooksResponse' examples: list: summary: One registration returned 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: The unique identifier of the webhook registration. example: 550e8400-e29b-41d4-a716-446655440000 name: type: string description: The human-readable name of the registration. example: Operations webhook endpointUrl: type: string format: uri description: The HTTPS endpoint that receives event deliveries. example: https://hooks.example.com/transfer-events enabled: type: boolean description: Whether the registration is active. example: true eventTypes: type: array description: >- The event types this endpoint subscribes to. Absent when the registration receives every event type. items: type: string example: - transfer.completed createdAt: type: string format: date-time description: The timestamp when the registration was created. example: '2026-02-01T15:30:00Z' updatedAt: type: string format: date-time description: The timestamp of the last update. example: '2026-02-01T15:30:00Z' WebhookListPagination: type: object required: - limit - offset - returned - hasNextPage properties: limit: type: integer description: Maximum number of registrations requested. example: 50 offset: type: integer description: Number of registrations skipped. example: 0 returned: type: integer description: Number of registrations returned in this response. example: 25 hasNextPage: type: boolean description: Whether there are more registrations beyond the current page. example: false ErrorResponse: type: object required: - error properties: error: type: object required: - code - service - category - message - requestId properties: code: type: string description: >- The stable error code. Plugin errors use the `BTF-XXXX` format; JD SPB business/auth rejections pass through the raw vendor code verbatim (e.g. `AAC90`, `ACE95`, `DVE01`), and transport-level JD failures surface the synthetic markers `TRANSPORT` or `JD_MISSING_CODE`. Match on this value rather than on the HTTP status. example: BTF-0010 service: type: string description: The service or domain that produced the error. example: plugin category: type: string description: Machine-readable error category used for retry decisions. enum: - deterministic - transient - rate_limit - plugin example: deterministic message: type: string description: A human-readable error summary. example: >- Transfers can only be initiated Monday-Friday between 06:30 and 17:00 Brasília time requestId: type: string description: The request correlation ID. Present even when empty. example: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f fields: type: object additionalProperties: true description: >- Structured validation or retry metadata when available. Field-level, header, path, and query validation details are all returned here. example: currentTime: '2026-02-01T18:30:00-03:00' operatingHours: Mon-Fri 06:30-17:00 UTC-3 responses: BadRequest: description: >- Indicates that the request contains invalid input. Check the field details for specific validation errors. 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: Indicates that the request is missing a valid authentication token. 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: >- Indicates that the caller is authenticated but lacks permission for this operation, or the tenant is not licensed for this 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: >- Indicates that an external service (CRM, JD SPB, Midaz, or Fees) is temporarily unavailable. 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: >- JWT Bearer token authentication. The tenantId is derived from the bearer token or authenticated request context and is not supplied through X-Organization-Id. OAuth2ClientCredentials: type: oauth2 flows: clientCredentials: tokenUrl: /v1/login/oauth/access_token scopes: api: TED transfer API access OAuth2Password: type: oauth2 flows: password: tokenUrl: /v1/login/oauth/access_token scopes: api: TED transfer API access ````