> ## 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. # Criar webhook > Cadastra uma URL para receber eventos assinados. O segredo de assinatura (`secret`) vem só nesta resposta; guarde no seu gerenciador de segredos. Se perder, gere outro em `POST /account/webhooks/{endpointID}/rotate-secret`. ## OpenAPI ````yaml /api-reference/openapi.pt-BR.json post /account/webhooks 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 - name: Rail - name: Lojas paths: /account/webhooks: post: tags: - Webhooks summary: Criar webhook description: > Cadastra uma URL para receber eventos assinados. O segredo de assinatura (`secret`) vem só nesta resposta; guarde no seu gerenciador de segredos. Se perder, gere outro em `POST /account/webhooks/{endpointID}/rotate-secret`. operationId: createWebhook parameters: - $ref: '#/components/parameters/IdempotencyKey' requestBody: required: true content: application/json: schema: type: object required: - url - events properties: url: type: string format: uri description: URL HTTPS que recebe as entregas. events: type: array items: type: string example: - payment.confirmed - invoice.finalized description: >- Eventos a receber, como `payment.confirmed` e `invoice.finalized`. responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreatedWebhookEndpoint' description: Endpoint criado, com o segredo de assinatura. '401': $ref: '#/components/responses/Unauthorized' '422': $ref: '#/components/responses/ValidationFailed' '503': content: application/json: schema: $ref: '#/components/schemas/Error' description: >- `secret_store_unavailable`: não foi possível guardar o segredo agora. Com chave de sandbox (`sk_test_`) a resposta é sempre esta; acompanhe o pagamento por consulta em vez de webhook. components: 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. schemas: CreatedWebhookEndpoint: allOf: - $ref: '#/components/schemas/WebhookEndpoint' - type: object properties: secret: type: string description: >- O endpoint recém-criado, com o segredo de assinatura (`secret`), que aparece só aqui. 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`. WebhookEndpoint: type: object properties: id: type: string format: uuid 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 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. responses: Unauthorized: content: application/json: schema: $ref: '#/components/schemas/Error' description: Chave ausente ou inválida. 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. ````