Lead

Webhooks

Disponibilizamos os seguintes webhooks para leads. Se o corretor fizer parte de uma imobiliária os leads recebidos por ele ativarão os webhooks cadastrados no perfil da imobiliária apenas:

type.d.ts


//é enviado toda vez que o corretor recebe um lead:
interface CreateLeadWebhook {
  event: "lead:create";
  userSlug: string;
  lead: Lead;
}

Definição de lead que é enviada via webhook

Os tipos mais complexos que compõe a lead estão definidos individualmente abaixo. Os links estão à direita.

type.d.ts


export interface Lead {
  id: string;
  origin: LeadOrigin;
  ogAdvertiser: User;
  advertiser: User;
  advertiserHistory: {
    advertiser: User;
    date: Date;
  }[];
  property: PropertyEmbed | null;
  client: Client;
  transactionType: "RENT" | "SELL";
  message: string | null;
  archived: boolean;
  createdAt: Date;
}

Client

type.d.ts


export interface Client {
  name: string | null;
  email: string | null;
  phone: string | null;
  whatsapp: string | null;
}

PropertyEmbed

type.d.ts


export interface PropertyEmbed {
  id: string;
  base36Id: string;
  address: Address;
  image: string | null;
  use: Use;
  features: PropertyFeature[];
  type: Type;
  areas: Areas;
  manager: User;
}

LeadOrigin

type.d.ts


type LeadOrigin =
  | "ZAP"
  | "CHAVES_NA_MAO"
  | "CASA_MINEIRA"
  | "IMOVEL_WEB"
  | "SP_IMOVEL"
  | "ORULO"
  | "INDICACAO"
  | "SITE"
  | "OUTROS";