> ## 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. # Criar webhook > Cadastra um endpoint que passará a receber as notificações dos eventos escolhidos — venda aprovada, reembolso, assinatura. A URL é testada na hora: um endereço que não responde recusa o cadastro com 400, então publique o endpoint antes de chamar. Restringir por `productIds` ou `offerIds` limita as notificações àquele recorte; produtos e ofertas de outra empresa também respondem 400. ## OpenAPI ````yaml /openapi.yaml post /v1/webhooks 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: post: tags: - Plataforma summary: Criar webhook description: >- Cadastra um endpoint que passará a receber as notificações dos eventos escolhidos — venda aprovada, reembolso, assinatura. A URL é testada na hora: um endereço que não responde recusa o cadastro com 400, então publique o endpoint antes de chamar. Restringir por `productIds` ou `offerIds` limita as notificações àquele recorte; produtos e ofertas de outra empresa também respondem 400. operationId: createWebhook requestBody: required: true content: application/json: schema: type: object properties: url: type: string format: uri description: URL que recebe o POST de cada evento assinado. 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 assinados por este endpoint. Pelo menos um é obrigatório. name: type: string minLength: 1 maxLength: 255 description: Apelido do webhook, para reconhecê-lo na lista. isActive: type: boolean default: true description: '`false` cadastra o webhook já pausado.' productIds: type: array items: type: string pattern: ^[cC][^\s-]{8,}$ maxItems: 50 description: >- Restringe o webhook a estes produtos. Omitido, vale para todos os produtos da empresa. offerIds: type: array items: type: integer exclusiveMinimum: true minimum: 0 maxItems: 50 description: >- Restringe o webhook a estas ofertas. Omitido, vale para todas as ofertas. required: - url - events additionalProperties: false example: url: https://erp.minhaloja.com.br/integracoes/ephra events: - transaction_paid - transaction_refunded name: ERP da loja isActive: true responses: '201': description: Webhook cadastrado. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `true` em uma resposta bem-sucedida. data: type: object properties: id: type: integer description: Identificador do webhook. name: type: string nullable: true description: >- Apelido do webhook, para o vendedor reconhecê-lo na lista. url: type: string description: URL que recebe o POST de cada evento assinado. 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 description: Eventos assinados por este endpoint. isActive: type: boolean description: '`false` pausa as entregas sem apagar o cadastro.' productIds: type: array items: type: string description: >- Produtos que disparam este webhook. Lista vazia significa todos os produtos da empresa. offerIds: type: array items: type: integer description: >- Ofertas que disparam este webhook. Lista vazia significa todas as ofertas. signatureSecretMasked: type: string description: >- Segredo da assinatura HMAC, mascarado: só os 4 últimos caracteres aparecem. mtlsCapable: type: boolean description: >- `true` quando o endpoint aceita mTLS com o certificado da Ephra. createdAt: type: string format: date-time description: Momento do cadastro do webhook. updatedAt: type: string format: date-time description: Momento da última alteração. required: - id - name - url - events - isActive - productIds - offerIds - signatureSecretMasked - mtlsCapable - createdAt - updatedAt additionalProperties: false required: - success - data additionalProperties: false description: Webhook cadastrado. example: success: true data: id: 412 name: ERP da loja url: https://erp.minhaloja.com.br/integracoes/ephra events: - transaction_paid - transaction_refunded isActive: true productIds: [] offerIds: [] signatureSecretMasked: ••••••••9f2c mtlsCapable: false createdAt: '2026-08-14T11:02:00.000Z' updatedAt: '2026-09-08T16:40:00.000Z' '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 possivel testar a url do webhook '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 '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 ````