Documentação

ReferênciaEventos de webhook

Lead qualificado

O corpo é o lead inteiro; uma lista ou um mapa vazio pode vir null. Um lead retido pelo limite do plano chega só com id, source, created_at e held, e não envia party.created. O negócio envia deal.created, quando foi aberto agora, ou deal.updated.

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.

assigned_at?string
Formatdate-time
assigned_user_id?string
assigned_user_name?string

Nome do responsável

contact_name?string

Nome do contato, ou o telefone quando não há nome. Ausente se a credencial não pode ver o contato.

contact_phone?string
created_at*string

Data de criação

Formatdate-time
created_by*string

Identificador de quem criou

custom_fields*|null
deal_id?string

Negócio a que o lead pertence

discard_reason?string
discarded_at?string
Formatdate-time
first_response_at?string
Formatdate-time
held*boolean

Retido pelo limite do plano até o upgrade

id*string
message?string
organization_id*string

Identificador da organização

party_id*string

Contato que enviou o interesse

property_id?string
purpose*string

Value in

  • "compra"
  • "locacao"
qualified_at?string
Formatdate-time
raw_payload?unknown

Ausente se a credencial não pode ver o contato

search_profile?
sla_due_at?string

Até quando o responsável atual precisa responder, contado no horário comercial da organização. Ausente quando ele já respondeu ou quando a vez dele não tem prazo.

Formatdate-time
source*string

Value in

  • "olx"
  • "grupozap"
  • "chavesnamao"
  • "zap"
  • "vivareal"
  • "site_form"
  • "whatsapp"
  • "indicacao"
  • "manual"
  • "api"
  • "assistant"
source_reference?string
stage*string

Value in

  • "novo"
  • "em_contato"
  • "qualificado"
  • "descartado"
tenant_id*string

Identificador do tenant

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/lead.qualified