Catálogo de eventos de webhook — Outros eventos de saída

Esta página documenta os eventos de product_tax e tax_payment_form. São eventos de baixo volume, nunca documentados antes desta página. Envelope: achatado na raiz, igual a NF-e e NFC-e.

Política de entrega

• Entrega: at-least-once. Garanta idempotência no seu endpoint.
• Retry: reentrega automática em falha de rede ou resposta não-2xx.
• Timeout: responda 2xx rápido e processe de forma assíncrona.
• Assinatura: valide o HMAC do cabeçalho antes de processar. Veja Dúvidas frequentes.

Eventos de product_tax

product_tax representa o cadastro de regras fiscais de um SKU. Não é documento fiscal — não tem accessKey nem authorization.

product_tax.created_successfully

Quando dispara: uma regra fiscal de produto foi criada e está ativa.

Payload:

{
  "tenantId": "6f3a9c1e8b2d4f507a1c9e3b",
  "id": "9945c26da840f80a",
  "collectionId": "5e8f2a1b9c3d4e6f7a8b9c0d",
  "status": "Active",
  "createdAt": "2026-08-17T20:01:01.98Z",
  "lastModified": "2026-08-18T02:19:36.73Z",
  "sku": "4413",
  "origin": "National",
  "description": "Regra fiscal de produto exemplo",
  "tax": {
    "ncm": "27101932"
  },
  "customTax": [
    {
      "issuer": { "taxRegime": "NationalSimple", "taxProfile": "retail" },
      "issuerTaxProfile": "retail",
      "recipient": { "taxProfile": "final_consumer_non_icms_contributor" },
      "operationCode": 121,
      "intrastate": { "cfop": 5405, "icms": { "cst": "500" } }
    }
  ]
}

Idempotency key: id.

product_tax.custom_rules_requested

Quando dispara: a regra fiscal exige uma combinação de CFOP/CST que não tem regra automática — o produto entra em CustomTaxPending até você definir a regra manualmente.

Payload:

{
  "tenantId": "6f3a9c1e8b2d4f507a1c9e3b",
  "id": "9945c26da840f80a",
  "collectionId": "5e8f2a1b9c3d4e6f7a8b9c0d",
  "status": "CustomTaxPending",
  "sku": "WJ104",
  "origin": "ForeignInternalMarket",
  "description": "Regra fiscal de produto exemplo",
  "tax": {
    "ncm": "84672910",
    "cest": "0801900"
  },
  "customTax": [
    {
      "issuer": { "taxRegime": "PresumedProfit", "taxProfile": "retail" },
      "issuerTaxProfile": "retail",
      "recipient": { "taxProfile": "final_consumer_non_icms_contributor" },
      "operationCode": 121,
      "intrastate": { "cfop": 5102, "icms": { "cst": "00" } },
      "interstate": { "cfop": 6108, "icms": { "cst": "00" } }
    }
  ]
}

Trate CustomTaxPending como ação pendente

Um produto em CustomTaxPending não emite documentos até a regra ser definida. Monitore este evento para não travar sua operação.

Idempotency key: id.

Eventos de tax_payment_form

tax_payment_form representa a guia de pagamento de um tributo. Baixo volume — poucos eventos observados em 30 dias de produção.

tax_payment_form.created_successfully

Quando dispara: a guia de pagamento foi gerada com sucesso.

Payload:

{
  "taxFineValue": 0,
  "taxInterestValue": 0,
  "taxOriginalValue": 5.25,
  "taxTotalValue": 5.25,
  "paymentDate": "2026-08-19",
  "dueDate": "2026-08-19",
  "barCode": "34191790010104351004791020150008291070026000",
  "pdfUrl": "https://exemplo.nfe.io/guias/guia-exemplo.pdf",
  "id": "95f0299f518dd29",
  "accountId": "6a889d6f8eb325000111a3fb",
  "companyId": "6a889d6f8eb325000111a3fc"
}

Idempotency key: id.

tax_payment_form.creation_failed

Quando dispara: a geração da guia falhou.

Payload:

{
  "errorMessage": "Received status Error",
  "id": "7f12111731e4a448",
  "accountId": "6a889d6f8eb325000111a3fb",
  "companyId": "6a889d6f8eb325000111a3fc"
}

Este evento não traz flowMessage detalhado — apenas confirma que a geração falhou. Consulte a guia pela API para mais contexto.

Idempotency key: id.

Como validar a assinatura

Veja o exemplo de validação de HMAC em Dúvidas frequentes — o mecanismo é o mesmo para todos os eventTypes.

Veja também

• Catálogo de eventos — visão geral
• Catálogo de eventos de saída — NFS-e
• Catálogo de eventos de saída — NF-e
• Catálogo de eventos de saída — NFC-e