Documentação

ReferênciaEventos de webhook

Imóvel 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.

bathrooms?integer

Banheiros

Formatint64
bedrooms?integer

Quartos

Formatint64
broker_id?string

Corretor responsável, vindo de uma importação

cep?string

CEP (8 dígitos, sem formatação)

city?string

Cidade

city_ibge_code?string

Código IBGE da cidade

complement?string

Complemento

condo_fee?integer

Condomínio mensal, em centavos

Formatint64
construction_year?integer

Ano de construção

Formatint64
created_at*string

Data de criação

Formatdate-time
created_by*string

Identificador de quem criou

development_name*string

Nome do edifício ou condomínio

district?string

Bairro

features?array<string>|

Características do imóvel

id*string

Identificador único do imóvel

iptu?integer

IPTU anual, em centavos

Formatint64
living_area?number

Área útil, em m²

Formatdouble
lot_area?number

Área do terreno, em m²

Formatdouble
number?string

Número

organization_id*string

Identificador da organização

owner_party_id?string

Proprietário, vindo de uma importação

parking_spaces?integer

Vagas de garagem

Formatint64
property_type?string

Tipo do imóvel

Value in

  • "apartment"
  • "garden_apartment"
  • "house"
  • "gated_community_house"
  • "penthouse"
  • "building"
  • "townhouse"
  • "studio"
  • "lot"
reference_code?string

Código de referência da imobiliária

state?string

UF (sigla de 2 letras)

street?string

Logradouro

suites?integer

Suítes

Formatint64
tenant_id*string

Identificador do tenant

total_area?number

Área total, em m²

Formatdouble
updated_at*string

Data da última atualização

Formatdate-time
updated_by*string

Identificador de quem atualizou

video_url?string

Vídeo do imóvel

virtual_tour_url?string

Tour virtual do imóvel

visibility*string

Nível de visibilidade do recurso

Value in

  • "restricted"
  • "organization"

Response Body

Example Requests

POST/property.updated