> ## Documentation Index > Fetch the complete documentation index at: https://docs.zeriqpay.com.br/llms.txt > Use this file to discover all available pages before exploring further. # Entregas do endpoint > Lista as entregas de um endpoint específico Use esta rota quando você quiser acompanhar somente as entregas de um endpoint. O `id` é o identificador do endpoint criado no submenu Gerenciamento. ## Autenticação Todas as rotas exigem `X-API-Key` com uma chave que começa com `zeriq_`. ```bash cURL theme={null} curl "https://api.zeriqpay.com.br/v1/webhooks/cmid_webhook/deliveries?status=FAILED" \ -H "X-API-Key: zeriq_sua_chave" ``` ## Escopos necessários * Listagem e consulta: `webhooks.read` * Reenvio individual ou em lote: `webhooks.retry` ## Filtros `page`, `limit`, `status`, `event`, `dateFrom`, `dateTo`, `endpointId` e `search` podem ser usados nas rotas de listagem. O reenvio em lote também aceita `maxItems`. ## Referência * **Método:** `GET` * **Rota:** `/v1/webhooks/{id}/deliveries` * **Autenticação:** `X-API-Key` ## Exemplo de resposta ```json theme={null} { "success": true, "data": { "items": [ { "id": "cmid_delivery", "endpointId": "cmid_webhook", "userId": "cmid_user", "transactionId": "cmid_transaction", "event": "payment.failed", "status": "FAILED", "payload": { "id": "evt_123", "event": "payment.failed", "createdAt": "2026-10-28T12:00:00.000Z", "data": {} }, "response": { "status": 500, "body": "upstream error", "error": "HTTP 500" }, "attempts": 3, "lastAttemptAt": "2026-10-28T12:02:00.000Z", "lastResponseStatus": 500, "lastResponseBody": "upstream error", "lastError": "HTTP 500", "deliveredAt": null, "replayedFromDeliveryId": null, "replayReason": null, "createdAt": "2026-10-28T12:00:00.000Z", "updatedAt": "2026-10-28T12:02:00.000Z" } ], "pagination": { "page": 1, "limit": 20, "total": 1, "pages": 1 } } } ``` ## Respostas A operação de listagem retorna `items` e `pagination`. A consulta detalhada também retorna `payload`, `response` e `attempts`. As rotas de reenvio respondem com HTTP `202` porque a entrega é colocada em fila para processamento assíncrono. A referência OpenAPI abaixo contém parâmetros, exemplos de request e response e códigos de erro. ## OpenAPI ````yaml GET /v1/webhooks/{id}/deliveries openapi: 3.1.0 info: title: ZeriqPay API description: >- Referência da API v1 da ZeriqPay. As rotas de gerenciamento de webhooks não fazem parte desta documentação. version: 1.0.0 contact: name: ZeriqPay url: https://api.zeriqpay.com.br servers: - url: https://api.zeriqpay.com.br description: Produção security: - apiKeyAuth: [] tags: - name: Conta description: Dados, taxas e limites da conta - name: Pagamentos PIX description: Cobranças PIX - name: Transações description: Consulta de transações - name: Transferências description: Saídas PIX, cripto e internas - name: Reembolsos description: Reembolsos de cobranças - name: Disputas MED description: Consulta e envio de evidências MED - name: Webhooks description: Cadastro e configuração dos endpoints de webhook paths: /v1/webhooks/{id}/deliveries: get: tags: - Webhooks summary: Listar entregas do endpoint description: >- Lista entregas de um endpoint específico. **Escopo necessário:** `webhooks.read`. operationId: listEndpointDeliveries parameters: - name: id in: path required: true description: ID do endpoint. schema: type: string - name: page in: query required: false description: Página iniciando em 1. schema: type: string - name: limit in: query required: false description: Quantidade por página, de 1 a 100. schema: type: integer - name: status in: query required: false description: PENDING, DELIVERED ou FAILED. schema: type: string - name: event in: query required: false description: Evento do webhook. schema: type: string - name: dateFrom in: query required: false description: Data inicial ISO 8601. schema: type: string - name: dateTo in: query required: false description: Data final ISO 8601. schema: type: string - name: endpointId in: query required: false description: Filtra por endpoint. schema: type: string - name: search in: query required: false description: Busca textual. schema: type: string responses: '200': description: Entregas do endpoint. content: application/json: schema: $ref: '#/components/schemas/WebhookDeliveryListResponse' example: success: true data: items: - id: cmid_delivery endpointId: cmid_webhook userId: cmid_user transactionId: cmid_transaction event: payment.failed status: FAILED payload: id: evt_123 event: payment.failed createdAt: '2026-10-28T12:00:00.000Z' data: {} response: status: 500 body: upstream error error: HTTP 500 attempts: 3 lastAttemptAt: '2026-10-28T12:02:00.000Z' lastResponseStatus: 500 lastResponseBody: upstream error lastError: HTTP 500 deliveredAt: null replayedFromDeliveryId: null replayReason: null createdAt: '2026-10-28T12:00:00.000Z' updatedAt: '2026-10-28T12:02:00.000Z' pagination: page: 1 limit: 20 total: 1 pages: 1 '401': description: API Key ausente ou inválida content: application/json: schema: $ref: '#/components/schemas/GenericResponse' '403': description: Escopo insuficiente content: application/json: schema: $ref: '#/components/schemas/GenericResponse' '404': description: Entrega ou endpoint não encontrado content: application/json: schema: $ref: '#/components/schemas/GenericResponse' '429': description: Limite da rota excedido content: application/json: schema: $ref: '#/components/schemas/GenericResponse' security: - apiKeyAuth: [] components: schemas: WebhookDeliveryListResponse: type: object properties: success: type: boolean data: type: object properties: items: type: array items: $ref: '#/components/schemas/WebhookDelivery' pagination: type: object properties: page: type: integer limit: type: integer total: type: integer pages: type: integer GenericResponse: type: object properties: success: type: boolean message: type: string data: type: object additionalProperties: true required: - success WebhookDelivery: type: object properties: id: type: string endpointId: type: string userId: type: string transactionId: type: string nullable: true event: type: string status: type: string enum: - PENDING - DELIVERED - FAILED payload: type: object response: type: object properties: status: type: integer nullable: true body: type: string nullable: true error: type: string nullable: true attempts: type: integer lastAttemptAt: type: string format: date-time nullable: true lastResponseStatus: type: integer nullable: true lastResponseBody: type: string nullable: true lastError: type: string nullable: true deliveredAt: type: string format: date-time nullable: true replayedFromDeliveryId: type: string nullable: true replayReason: type: string nullable: true createdAt: type: string format: date-time updatedAt: type: string format: date-time endpoint: type: object nullable: true securitySchemes: apiKeyAuth: type: apiKey in: header name: X-API-Key description: API Key ZeriqPay iniciada por `zeriq_`. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.