Documentação

ReferênciaEventos de webhook

Contrato atualizado

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.

content?string
content_type*string

Formato do conteúdo

Value in

  • "tiptap"
  • "pdf"
  • "html"
contract_number?string

Número do contrato, espelhando o número da proposta com prefixo CONT-

contract_type*string

Tipo do contrato

Value in

  • "promessa"
  • "compromisso"
  • "amendment"
  • "addendum"
created_at*string

Data de criação

Formatdate-time
created_by*string

Identificador de quem criou

current_version*integer

Número da versão atual do contrato

Formatint64
document_plan_version*integer
Formatint64
draft_document_id?string
file_size?integer
Formatint64
file_type?string
fully_executed_at?string
Formatdate-time
has_signed_pdf*boolean

Se o PDF assinado está disponível

id*string

Identificador único do contrato

lawyer_email?string

E-mail do advogado

lawyer_review_notes?string
lawyer_review_required*boolean

Se requer revisão de advogado

lawyer_reviewed_at?string
Formatdate-time
organization_id*string

Identificador da organização

proposal_id*string

Identificador da proposta vinculada

reviewed_at?string
Formatdate-time
reviewed_by?string
sent_for_signature_at?string
Formatdate-time
sent_version_number?integer
Formatint64
signature_envelope_id?string
signature_provider?string

Value in

  • "simple_consent"
  • "d4sign"
  • "manual"
signed_document_id?string
sinal_amount?integer

Valor do sinal em centavos

Formatint64
sinal_paid_at?string

Data de pagamento do sinal

Formatdate-time
sinal_payment_method?string

Método de pagamento do sinal

Value in

  • "pix"
  • "transfer"
  • "cash"
  • "check"
sinal_type?string

Tipo do sinal

Value in

  • "confirmatoria"
  • "penitencial"
status*string

Status do contrato

Value in

  • "draft"
  • "review"
  • "approved"
  • "pending_signature"
  • "partially_signed"
  • "fully_executed"
  • "cancelled"
template_id?string

Identificador do modelo utilizado

tenant_id*string

Identificador do tenant

title*string

Título do contrato

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/contract.updated

Contrato excluído Webhook

Página anterior

Negócio criado Webhook

Próxima página