Documentação

ReferênciaEventos de webhook

Proposta atualizada

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.

business_conditions*string

Condições comerciais

checklist_policy?string
content_file_size?integer
Formatint64
content_file_type?string
created_at*string

Data de criação

Formatdate-time
created_by*string

Identificador de quem criou

has_pdf*boolean

Se o PDF da proposta foi gerado

has_signed_pdf*boolean

Se o PDF assinado está disponível

id*string

Identificador único da proposta

key_delivery_terms*string

Condições de entrega das chaves

metadata?|

Metadados adicionais

notes?string

Observações

organization_id*string

Identificador da organização

payment_conditions*string
payment_method*string
pdf_file_type?string
pdf_generated_at?string
Formatdate-time
proposal_number?string

Número da proposta

signature_envelope_id?string
signature_expiry_days?integer
Formatint64
signature_type?string

Value in

  • "simple_consent"
  • "legally_binding"
signatures_completed_at?string
Formatdate-time
signatures_requested_at?string
Formatdate-time
status*string

Status da proposta

Value in

  • "draft"
  • "submitted"
  • "rejected"
  • "converted"
target_property_id*string

Identificador do imóvel objeto

template_id?string
tenant_id*string

Identificador do tenant

total_value*integer

Valor total em centavos

Formatint64
transaction_date?string

Data prevista da transação

Formatdate
transaction_location*string
transaction_type*string

Tipo da transação

Value in

  • "sale"
  • "exchange"
  • "exchange_with_cash"
  • "financing"
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/proposal.updated