> ## 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 supressão de webhook > Cria a regra que suprime parte das notificações de um evento, aliviando um endpoint sem apagar o webhook. Responde 400 quando já existe regra para aquele evento — nesse caso atualize a que existe em vez de criar outra. ## OpenAPI ````yaml /openapi.yaml post /v1/webhook-suppressions 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/webhook-suppressions: post: tags: - Plataforma summary: Criar supressão de webhook description: >- Cria a regra que suprime parte das notificações de um evento, aliviando um endpoint sem apagar o webhook. Responde 400 quando já existe regra para aquele evento — nesse caso atualize a que existe em vez de criar outra. operationId: createWebhookSuppression requestBody: required: true content: application/json: schema: 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 cujas notificações serão parcialmente suprimidas. interval: type: integer minimum: 2 description: >- Tamanho da janela: a cada quantos disparos a regra se repete. Mínimo 2. suppressCount: type: integer minimum: 1 default: 1 description: >- Quantos disparos de cada janela são suprimidos. Precisa ser menor que `interval`. isActive: type: boolean default: true description: '`false` cadastra a regra já desligada.' required: - event - interval additionalProperties: false example: event: transaction_created interval: 10 suppressCount: 9 isActive: true responses: '201': description: Supressão criada. 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 da supressão. event: type: string enum: - transaction_created - transaction_paid - transaction_refunded - transaction_updated - transfer_completed - transfer_canceled - transfer_created - transfer_updated - infraction - cart_abandoned - sale_lost - card_declined - product_canceled - company_approved - product_approved - product_refused - withdrawal_requested - withdrawal_sent - transaction_reversal - release_access - vturb_paid - vk_metrics_purchase - refund_requested description: Evento cujas notificações são parcialmente suprimidas. interval: type: integer description: >- Tamanho da janela: a cada quantos disparos a regra se repete. suppressCount: type: integer description: >- Quantos disparos de cada janela são suprimidos. Sempre menor que `interval`. counter: type: integer description: >- Posição atual dentro da janela, mantida pela plataforma. isActive: type: boolean description: >- `false` mantém a regra cadastrada mas volta a entregar tudo. createdAt: type: string format: date-time description: Momento de criação da regra. updatedAt: type: string format: date-time description: Momento da última alteração. required: - id - event - interval - suppressCount - counter - isActive - createdAt - updatedAt additionalProperties: false required: - success - data additionalProperties: false description: Supressão criada. example: success: true data: id: 27 event: transaction_created interval: 10 suppressCount: 9 counter: 0 isActive: true createdAt: '2026-09-02T09:15:00.000Z' updatedAt: '2026-09-11T19:03: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 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 '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 ````