Documentação

ReferênciaEventos de webhook

Documento criado

O corpo é o registro inteiro, sem os campos de link de compartilhamento, de assinatura e de arquivo; uma lista ou um mapa vazio pode vir null.

Header Parameters

X-Webhook-Event*string

O evento entregue.

X-Webhook-Signature*string

sha256= seguido do HMAC-SHA256, em hexadecimal, do corpo exatamente como recebido, com o segredo da assinatura (secret) como chave. Compare em tempo constante.

X-Webhook-Delivery?string

A entrega, a mesma em todas as tentativas: use-a para descartar repetições. Também é o id da entrega em GET /webhooks/{id}/deliveries. Ausente no teste (POST /webhooks/{id}/test).

User-Agent?string

Nobur-Webhooks/1.0. Ausente no teste (POST /webhooks/{id}/test).

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

classification?
company_participation_id?string
content_type?string
contract_id?string
created_at*string

Data de criação

Formatdate-time
created_by*string

Identificador de quem criou

display_name?string
expiry_date?string

Data de validade

Formatdate
failure?

Motivo da última tentativa de emissão com falha. Presente apenas em documentos com status failed; some quando uma emissão é concluída.

file_type?string

Tipo MIME do arquivo

has_file*boolean

Se o documento tem arquivo, que a rota de download entrega

id*string

Identificador único do documento

issue_date?string
Formatdate
metadata?|

Metadados adicionais

organization_id*string

Identificador da organização

origin*string

Value in

  • "user_upload"
  • "provider"
  • "other"
original_filename?string
party_id?string

Identificador da parte vinculada

party_name?string
plan_item_id?string
processing_profile*string

Value in

  • "classification"
  • "storage"
property_id?string

Identificador do imóvel vinculado

property_name?string
property_registration_id?integer
Formatint64
property_registration_number?string
property_tax_id?integer
Formatint64
proposal_id?string

Identificador da proposta vinculada

proposal_number?string
registry_office?string
status*string

Status do documento

Value in

  • "pending"
  • "processing"
  • "received"
  • "approved"
  • "expired"
  • "rejected"
  • "superseded"
  • "failed"
tenant_id*string

Identificador do tenant

type*string

Tipo do documento

Value in

  • "cnd_municipal"
  • "cnd_estadual"
  • "cnd_federal"
  • "cnd_civel"
  • "cnd_criminal"
  • "cnd_falencia"
  • "cnd_trabalhista"
  • "certidao_casamento"
  • "certidao_nascimento"
  • "matricula_imovel"
  • "imagem_matricula_imovel"
  • "cnd_condominio"
  • "cnd_ambiental"
  • "consulta_cnpj"
  • "cnd_eleitoral"
  • "ceat"
  • "contract"
  • "comprovante_residencia"
  • "rg"
  • "cnh"
  • "iptu"
  • "custom_manual"
updated_at*string

Data da última atualização

Formatdate-time
updated_by*string

Identificador de quem atualizou

visibility*string

Nível de visibilidade do recurso

Value in

  • "restricted"
  • "organization"

Response Body

Example Requests

POST/document.created

Negócio ganho Webhook

Página anterior

Documento excluído Webhook

Próxima página