Leads

Leads Webhook

É enviada uma notificação via webhook sempre que uma nova lead é recebida, desde que o CRM subscreva esta funcionalidade. Para receber estas notificações, o CRM deve fornecer um endpoint designado para onde o webhook possa ser direcionado.

Quando uma nova lead é capturada, o sistema aciona uma notificação webhook. Esta notificação é então enviada para o endpoint especificado, permitindo que o CRM processe e responda á lead em tempo real. Ao subscrever esta funcionalidade e fornecer o endpoint necessário, o CRM garante que é atualizado com as informações mais recentes das leads, permitindo uma gestão de leads rápida e eficaz.

---

Method POST

Headers

Nome	Tipo	Descrição
token	string	Token fornecido pela CasaYes ao CRM para identificar pedidos enviados para a API do CRM.

Body application/json WebhookEndpoint

Nome	Tipo	Descrição
EntityType	string	['Listing', 'Office', 'BusinessForm', 'User', 'EvaluationForm']
EntityPublicId	string	Id público da entidade no CasaYes.
EntityReference	string	Referência da entidade.
LeadReference	string	Id público da lead.
Source	string	'CasaYes'
CreatedDate	datetime	Data de criação da lead.
Message	string	Mensagem da lead.
SenderName	string	Nome do remetente.
SenderEmail	string	Email do remetente.
SenderPhone	string	Contacto telefónico do remetente
NumberResidents	integer	Número previsto de residentes para o apartamento.
HasPets	bool	Têm animais de estimação.
EstimatedDateToMove	string	['Soon', 'Flexible', 'ExactDate']
MonthlyIncome	integer	Rendimento mensal .
PresentationLetter	string	Carta de apresentação.

Requests

Exemplo

Method: POST
Headers: 
    { 
        "token": "0b4ba9b1-8e04-44cc-84ec-eb0579c0bb20"
    }
Body: 
    {
        "CreatedDate": "2024-08-09T15:05:44.6131515Z",
        "EntityPublicId": "A3bT7Y2xL6w",
        "EntityReference": "857632194-6",
        "EntityType": "Listing",
        "EstimatedDateToMove": "2024-12-09T15:05:44.6131515Z",
        "HasPets": false,
        "LeadReference": "CY-Listing-A3bT7Y2xL6w-b24e6f80-17c9-4a8f-92b3-7e123d4bcf90",
        "Message": "Hi, I’m interested in this listing and would like to schedule a viewing. Please contact me. Thanks",
        "MonthlyIncome": 2000,
        "NumberResidents": 2,
        "PresentationLetter": "",
        "SenderEmail": "[email protected]",
        "SenderName": "John Smith",
        "SenderPhone": "919111222",
        "Source": "CasaYes"
    }