> ## Documentation Index > Fetch the complete documentation index at: https://docs.beinfi.com/llms.txt > Use this file to discover all available pages before exploring further. # Atualizar webhook > Muda os eventos, liga ou desliga o endpoint. Envie `isActive`, `events` ou os dois; o que não vier fica como está. `events` substitui a lista inteira. A URL e o segredo não mudam aqui (o segredo muda em `rotate-secret`). ## OpenAPI ````yaml /api-reference/openapi.pt-BR.json patch /account/webhooks/{endpointID} openapi: 3.1.0 info: title: Infi API version: 0.0.1 description: > A API REST do Infi: catálogo, clientes, medição de uso, assinaturas, faturas, pagamentos e checkout. **Autenticação.** Envie a chave secreta em `Authorization: Bearer sk_test_…` (sandbox) ou `sk_live_…` (produção). O prefixo da chave decide o ambiente. As rotas de checkout (`/pay/*`) e `/public/*` não levam chave: rodam no navegador de quem paga. **Idempotência.** Toda requisição que altera dados exige o header `Idempotency-Key`. Uma repetição com a mesma chave devolve a resposta original em vez de executar de novo. **Valores.** Dinheiro e quantidades trafegam como texto decimal (`"150.00"`, `"0.0001"`), nunca como número de ponto flutuante. **Erros.** O corpo traz `error_code` (estável, use para decidir), `message` (para pessoas) e `tracer_id` (envie ao suporte). Erros de limite de requisições e de idempotência vêm aninhados em `error`, com `code` e `request_id`. servers: - url: https://api-sandbox.beinfi.com description: Sandbox - url: https://api.beinfi.com description: Produção security: - bearerAuth: [] tags: - name: Catálogo - name: Clientes - name: Medição de uso - name: Assinaturas - name: Faturas - name: Pagamentos - name: Checkout - name: Cupons - name: Cobrança - name: Conta - name: Webhooks - name: Conta de teste paths: /account/webhooks/{endpointID}: parameters: - name: endpointID in: path required: true schema: $ref: '#/components/schemas/WebhookEndpointId' patch: tags: - Webhooks summary: Atualizar webhook description: > Muda os eventos, liga ou desliga o endpoint. Envie `isActive`, `events` ou os dois; o que não vier fica como está. `events` substitui a lista inteira. A URL e o segredo não mudam aqui (o segredo muda em `rotate-secret`). operationId: patchWebhook parameters: - $ref: '#/components/parameters/IdempotencyKey' requestBody: required: true content: application/json: schema: type: object properties: isActive: type: boolean description: >- `true` liga, `false` desliga. Desligado, o endpoint não recebe entregas. events: type: array minItems: 1 items: $ref: '#/components/schemas/WebhookEventType' description: A nova lista de eventos. Pelo menos um. active: type: boolean deprecated: true description: Grafia antiga de `isActive`, ainda aceita. responses: '200': content: application/json: schema: $ref: '#/components/schemas/WebhookEndpoint' description: O endpoint atualizado. '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '422': $ref: '#/components/responses/ValidationFailed' components: schemas: WebhookEndpointId: type: string pattern: ^we_[0-9A-Za-z]{22}$ example: we_3Tz8yU1oI4pA7sD0fG2hJk WebhookEventType: type: string enum: - checkout.session.created - checkout.session.completed - checkout.session.expired - customer.created - customer.converted - invoice.finalized - invoice.sent - invoice.paid - invoice.voided - invoice.uncollectible - invoice.auto_collection_failed - payment.confirmed - payment.failed - payment.refunded - payment.refund_reversed - payment.chargeback - payment.chargeback_reversed - plan.changed - usage.threshold_reached - credit.balance_low - credit.balance_depleted - subscription.cancel_scheduled - subscription.cancel_unscheduled - subscription.canceled - subscription.past_due - refund_request.created - payment.duplicate_detected - payment.duplicate_refunded - refund_request.declined WebhookEndpoint: type: object required: - id - url - events - isActive - createdAt properties: id: $ref: '#/components/schemas/WebhookEndpointId' url: type: string format: uri description: URL que recebe as entregas. events: type: array items: type: string description: >- Eventos assinados. Qualquer evento emitido pode ser assinado pelo nome, inclusive os que ainda não têm payload documentado. isActive: type: boolean description: Se o endpoint está recebendo entregas. createdAt: type: string format: date-time Error: type: object required: - message - error_code - tracer_id properties: message: type: string description: Frase legível para pessoas. error_code: $ref: '#/components/schemas/ErrorCode' description: Código estável do erro. Use-o para decidir o que fazer. tracer_id: type: string description: Identificador da requisição. Informe-o ao falar com o suporte. description: >- O corpo de erro padrão. É plano (sem o envelope `error`) e o identificador de rastreio é `tracer_id`. NotFoundError: type: object required: - message - error_code - tracer_id - resource properties: message: type: string error_code: $ref: '#/components/schemas/ErrorCode' tracer_id: type: string resource: type: string ValidationError: type: object required: - message - error_code - tracer_id - errors properties: message: type: string error_code: $ref: '#/components/schemas/ErrorCode' tracer_id: type: string errors: type: array items: type: object required: - field - value - constraint - description properties: field: type: string value: type: string constraint: type: string description: type: string description: >- Detalhe por campo (`field`, `description`). Sempre presente num `422`; pode vir vazio. description: >- Corpo de um `422`. Mesmo formato de `Error`, mais `errors[]` com o detalhe por campo. É ali que está a frase que diz o que corrigir (por exemplo, "product has no published version"). ErrorCode: type: string examples: - internal_error - validation_failed - bad_request - unauthorized - forbidden - not_found - conflict - rate_limited description: >- Código estável do erro. A lista não é fechada: além dos códigos genéricos, cada área tem os seus (`coupon_expired`, `insufficient_balance`, `version_not_draft`, `idempotency_key_reused`…). Um código que você não conhece deve ser tratado pelo status HTTP, mostrando `message`; não falhe ao ler a resposta. parameters: IdempotencyKey: name: Idempotency-Key in: header required: false schema: type: string description: >- Chave única por operação (um UUID serve). Repetir com a mesma chave devolve a resposta original. responses: BadRequest: content: application/json: schema: $ref: '#/components/schemas/Error' description: Requisição malformada. Unauthorized: content: application/json: schema: $ref: '#/components/schemas/Error' description: Chave ausente ou inválida. NotFound: content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: Recurso não encontrado. ValidationFailed: content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: >- Um ou mais campos são inválidos. O detalhe de cada campo está em `errors[]`. securitySchemes: bearerAuth: type: http scheme: bearer description: >- Chave secreta da conta: `Authorization: Bearer sk_test_…` ou `sk_live_…`. Use só no servidor. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.