Documentação

ReferênciaEventos de webhook

Parte 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.

birthdate?string

Data de nascimento

Formatdate
cep?string

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

city?string

Cidade

city_ibge_code?string

Código IBGE da cidade

company_name?string

Razão social (pessoa jurídica)

complement?string

Complemento

created_at*string

Data de criação

Formatdate-time
created_by*string

Identificador de quem criou

district?string

Bairro

document_number*string

CPF ou CNPJ

email*string

E-mail

full_name?string

Nome completo (pessoa física)

id*string

Identificador único da parte

marital_status?string

Estado civil

marriage_regime?string

Regime de casamento

merged_at?string

Quando a parte foi mesclada

Formatdate-time
merged_by_actor_id?string

Quem fez a mesclagem: ID do usuário, da chave de API ou do sistema

merged_by_actor_type?string

Tipo de quem fez a mesclagem

Value in

  • "user"
  • "system"
  • "admin"
  • "api_key"
  • "external"
  • "party"
merged_into_id?string

Parte principal em que esta foi mesclada. Ausente quando a parte não está mesclada.

nationality?string

Nacionalidade

number?string

Número

organization_id*string

Identificador da organização

phone*string

Telefone

prenuptial_agreement?|

Dados do pacto antenupcial

profession?string

Profissão

state?string

UF (sigla de 2 letras)

street?string

Logradouro

tenant_id*string

Identificador do tenant

type*string

Tipo da parte

Value in

  • "person"
  • "company"
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"
whatsapp_consent_actor_id?string

Quem registrou o consentimento

whatsapp_consent_actor_type?string

Tipo de quem registrou o consentimento

Value in

  • "user"
  • "system"
  • "admin"
  • "api_key"
  • "external"
  • "party"
whatsapp_consent_at?string

Quando a parte consentiu em receber mensagens pelo WhatsApp

Formatdate-time

Response Body

Example Requests

POST/party.updated

Mesclagem desfeita Webhook

Página anterior

Imóvel criado Webhook

Próxima página