Pular para o conteúdo principal

Webhooks CTE e NFe Fulfillment

Os webhooks permitem que você obtenha notificações programáticas em tempo real sobre alterações no rastreamento de solicitações de documentos fiscais em lote à medida que elas acontecem. Em vez de extrair informações por meio de nossa API, os webhooks enviarão informações diretamente ao seu endpoint configurado.

Para registrar um webhook é necessário seguir os passos existentes na documentação de webhooks.

🔔 Tópicos de Inscrição e Exemplos de Notificações​

Ao se inscrever para receber notificações do nosso webhook, sua URL receberá mensagens referentes a diferentes tópicos, cada um relacionado a um recurso específico.

Tópico Descrição Possíveis Status Exemplo de Mensagem
fiscal_document_batch_download_notification Eventos gerados durante o batch download. Irá notificar sobre a geração do link do arquivo. Escopo: open:logistic-fiscal-documents-seller:read PENDING, COMPLETED_SUCCESS, COMPLETED_PARTIAL, COMPLETED_FAILURE, COMPLETED_NOT_FOUND 
{
  "data": {
    "status": "PENDING",
    "zip_contents": "XML",
    "msg": "NFE export completed successfully",
    "file_export_summary": {
      "url_download": "https://3p-fulfillment.s3.sa-east-1.amazonaws.com/Invoice/zips/{id}.zip",
      "total_files_status": {
        "requested": 1,
        "successful": 1,
        "failed": 0
      },
      "size_metrics": {
        "total_size_bytes": 0
      }
    },
    "expires_at": "2025-12-19T16:58:00.796732Z"
  },
  "tenant_id": "1ca52337-7e79-4952-a0c0-80b65f630c5e",
  "topic": "fiscal_document_batch_download_notification"
}

Receba Atualizações por Webhook​

Para configurar um webhook, siga a documentação do portal de desenvolvedores.

ℹ️ Observação

Este tópico é específico para vendedores e contém eventos detalhados da solicitação de documentos fiscais em lote.