> ## Documentation Index > Fetch the complete documentation index at: https://docs.ephra.io/llms.txt > Use this file to discover all available pages before exploring further. # Testar webhook > Dispara payloads de teste, com dados fictícios, para a URL cadastrada e devolve o status HTTP que o seu servidor respondeu a cada um. Use para validar a integração antes de depender dela em produção. Nenhuma venda real é criada ou alterada. ## OpenAPI ````yaml /openapi.yaml post /v1/webhooks/{webhookId}/test openapi: 3.0.3 info: title: Ephra API description: >- API pública da Ephra: cobranças (PIX, cartão e boleto), transações, webhooks e a API do vendedor sobre catálogo, checkout, vendas, reembolsos, financeiro, crescimento e plataforma. **Limite de requisições.** 1000 requisições por minuto por IP de origem. Toda resposta traz `x-ratelimit-limit`, `x-ratelimit-remaining` e `x-ratelimit-reset` (segundos até a janela zerar); ao estourar o limite a resposta é `429` com `retry-after`. **Erros.** Toda falha responde o mesmo envelope: `{ "success": false, "message": "..." }`. version: 1.0.0 servers: - url: https://api.ephra.io description: Servidor de produção security: [] tags: - name: Catálogo description: Produtos, ofertas, categorias e cupons — o que a empresa vende. - name: Checkout description: Checkouts, order bumps, upsells e links de pagamento. - name: Vendas description: Vendas, clientes, assinaturas e entregas já realizadas. - name: Reembolsos description: Pedidos de reembolso, contestações e o quiz de retenção. - name: Financeiro description: Saldo, saques, antecipações, taxas e extratos da empresa. - name: Crescimento description: Afiliados, coprodução, indicações, pixels e integrações de marketing. - name: Plataforma description: Conta, membros, chaves de API, webhooks e configurações gerais. paths: /v1/webhooks/{webhookId}/test: post: tags: - Plataforma summary: Testar webhook description: >- Dispara payloads de teste, com dados fictícios, para a URL cadastrada e devolve o status HTTP que o seu servidor respondeu a cada um. Use para validar a integração antes de depender dela em produção. Nenhuma venda real é criada ou alterada. operationId: testWebhook parameters: - schema: type: integer exclusiveMinimum: true minimum: 0 in: path name: webhookId required: true description: Identificador do webhook. requestBody: required: true content: application/json: schema: type: object properties: events: type: array items: type: string enum: - transaction_created - transaction_paid - transaction_refunded - transaction_updated - transfer_completed - transfer_canceled - transfer_created - transfer_updated - infraction - card_declined - sale_lost - cart_abandoned - product_canceled - release_access - vturb_paid - vk_metrics_purchase - refund_requested minItems: 1 maxItems: 17 description: >- Eventos a disparar no teste. Omitido, dispara um payload de cada evento assinado. Um evento que o webhook não assina responde 400. additionalProperties: false example: events: - transaction_paid responses: '200': description: Resultado do disparo de teste. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `true` em uma resposta bem-sucedida. data: type: object properties: webhookId: type: integer description: Webhook testado. url: type: string description: URL que recebeu os payloads de teste. results: type: array items: type: object properties: event: type: string enum: - transaction_created - transaction_paid - transaction_refunded - transaction_updated - transfer_completed - transfer_canceled - transfer_created - transfer_updated - infraction - card_declined - sale_lost - cart_abandoned - product_canceled - release_access - vturb_paid - vk_metrics_purchase - refund_requested description: Evento cujo payload de teste foi enviado. success: type: boolean description: '`true` quando o seu servidor respondeu 2xx.' httpStatus: type: integer nullable: true description: Status HTTP devolvido pelo seu servidor. error: type: string nullable: true description: >- Motivo da falha, quando o envio não foi bem-sucedido. required: - event - success - httpStatus - error additionalProperties: false description: Um resultado por evento disparado. required: - webhookId - url - results additionalProperties: false required: - success - data additionalProperties: false description: Resultado do disparo de teste. example: success: true data: webhookId: 412 url: https://erp.minhaloja.com.br/integracoes/ephra results: - event: transaction_paid success: true httpStatus: 200 error: null '400': description: A requisição está bem formada, mas uma regra de negócio a recusou. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `false` em uma resposta de erro. message: type: string description: Mensagem legível explicando a falha. required: - success - message additionalProperties: false description: >- A requisição está bem formada, mas uma regra de negócio a recusou. example: success: false message: >- Não foi possível concluir: uma regra de negócio recusou os dados enviados. '401': description: Token ausente, inválido, expirado ou de empresa bloqueada. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `false` em uma resposta de erro. message: type: string description: Mensagem legível explicando a falha. required: - success - message additionalProperties: false description: Token ausente, inválido, expirado ou de empresa bloqueada. example: success: false message: Token inválido ou expirado '404': description: O recurso não existe, foi excluído ou pertence a outra empresa. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `false` em uma resposta de erro. message: type: string description: Mensagem legível explicando a falha. required: - success - message additionalProperties: false description: >- O recurso não existe, foi excluído ou pertence a outra empresa. example: success: false message: Recurso não encontrado '422': description: A requisição não passou na validação de schema. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `false` em uma resposta de erro. message: type: string description: Mensagem legível explicando a falha. required: - success - message additionalProperties: false description: A requisição não passou na validação de schema. example: success: false message: 'name: Nome é obrigatório' '429': description: >- Requisições demais: o limite é de 1000 requisições por minuto por IP de origem. Espere o número de segundos do header `retry-after` e repita com recuo exponencial. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `false` em uma resposta de erro. message: type: string description: Mensagem legível explicando a falha. required: - success - message additionalProperties: false description: >- Requisições demais: o limite é de 1000 requisições por minuto por IP de origem. Espere o número de segundos do header `retry-after` e repita com recuo exponencial. example: success: false message: Muitas requisições. Tente novamente em breve. headers: retry-after: $ref: '#/components/headers/retry-after' x-ratelimit-limit: $ref: '#/components/headers/x-ratelimit-limit' x-ratelimit-remaining: $ref: '#/components/headers/x-ratelimit-remaining' x-ratelimit-reset: $ref: '#/components/headers/x-ratelimit-reset' '500': description: >- Falha interna ao processar a requisição. Repita; se persistir, abra chamado com o horário e a rota. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `false` em uma resposta de erro. message: type: string description: Mensagem legível explicando a falha. required: - success - message additionalProperties: false description: >- Falha interna ao processar a requisição. Repita; se persistir, abra chamado com o horário e a rota. example: success: false message: Erro interno do servidor security: - bearerAuth: [] components: headers: retry-after: description: Segundos a esperar antes de repetir a requisição. schema: type: integer x-ratelimit-limit: description: Teto de requisições na janela (1000). Presente em toda resposta. schema: type: integer x-ratelimit-remaining: description: >- Quantas requisições ainda cabem na janela atual. Presente em toda resposta. schema: type: integer x-ratelimit-reset: description: Segundos até o contador da janela zerar. Presente em toda resposta. schema: type: integer securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT ````