Webhook · enviado pelo Cuidaro
NFS-e autorizada
EVENTO
fiscal_invoice.issued
NFS-e da OS autorizada pela prefeitura. Só para OS criadas pela API e só para os endpoints da integração que criou a OS (outra integração da mesma empresa não recebe); endpoint ativo e inscrito no evento. Emitido desde o ECO-API-4b (27/10/2026), depois de a mudança estar gravada, uma vez por transição (deduplique por Cuidaro-Event-Id). Sem dado pessoal do cliente.
Cabeçalhos
Cuidaro-Signature
string · cabeçalho
obrigatório
t=<unix>,v1=<hex> — v1 = HMAC-SHA256 com o segredo do endpoint sobre "<t>.<corpo bruto>" (esquema do Stripe). Compare em tempo constante e recuse t com mais de 300 s de diferença.
Cuidaro-Event-Id
string · cabeçalho
obrigatório
Igual a id do corpo; não muda entre tentativas nem no reenvio. Use para deduplicar.
Cuidaro-Event-Type
string · cabeçalho
obrigatório
Igual a type do corpo.
User-Agent
string · cabeçalho
obrigatório
Corpo
id
string
obrigatório
evt_ + ULID em minúsculas. Chave de deduplicação: igual ao cabeçalho Cuidaro-Event-Id.
api_version
string
obrigatório
schema_version
string
obrigatório
type
string
obrigatório
created_at
string
obrigatório
UTC, sufixo Z.
data
object
obrigatório
Conteúdo específico do evento (ver webhooks).
service_order_id
integer
obrigatório
Id da OS no Cuidaro.
external_reference
string (anulável)
obrigatório
Referência que o seu sistema informou ao criar a OS.
fiscal_invoice_id
integer
obrigatório
Id da nota no Cuidaro.
type
string
obrigatório
number
string (anulável)
obrigatório
Número da NFS-e devolvido pela prefeitura (numeroNfse; nunca o número do RPS). null quando a prefeitura não informa.
issued_at
string (anulável)
obrigatório
Data da autorização.
pdf_url
string (anulável)
obrigatório
Link ASSINADO e temporário (72 h, cobre a janela de retentativas) do PDF servido pelo Cuidaro. Vencido, use GET /service-orders/{id}. null se o documento ainda não foi liberado.
xml_url
null
obrigatório
Sempre null nesta versão.
Veja como verificar a assinatura e como responder, deduplicar e lidar com retentativas.