Documentação

ReferênciaEventos de webhook

Visita agendada

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.

assignee_user_id?string
assignee_user_name?string
concluded_at?string
Formatdate-time
contact_name?string
created_at*string
Formatdate-time
created_by*string
created_by_type*string

Value in

  • "user"
  • "system"
  • "admin"
  • "api_key"
  • "external"
  • "party"
deal_id?string
duration_minutes*integer
Formatint64
ends_at*string
Formatdate-time
feedback?string

Retorno do corretor depois da visita

id*string
lead_id?string
listing_id?string
notes?string
organization_id*string
party_id*string
property_id?string
property_label?string

Empreendimento e endereço do imóvel; ausente quando não há imóvel ou quem lê não pode vê-lo

reminder_minutes?integer

Minutos antes da visita em que o corretor é lembrado; ausente quando não há lembrete

Formatint64
scheduled_at*string
Formatdate-time
status*string

Value in

  • "agendada"
  • "realizada"
  • "cancelada"
  • "nao_compareceu"
tenant_id*string
updated_at*string
Formatdate-time
updated_by?string

Response Body

Example Requests

POST/visit.scheduled