Leads

Leads Webhook

A notification via webhook is sent whenever a new lead is received, provided the CRM subscribes to this functionality. To receive these notifications, the CRM must provide a designated endpoint where the webhook can be directed.

When a new lead is captured, the system triggers a webhook notification. This notification is then sent to the specified endpoint, allowing the CRM to process and respond to the lead in real-time. By subscribing to this feature and supplying the necessary endpoint, the CRM ensures it is updated with the latest lead information, enabling prompt and effective lead management.

---

Method POST

Headers

Name	Type	Description
token	string	Token supplied by CasaYes to the CRM for identifying requests sent to the CRM API.

Body application/json WebhookEndpoint

Name	Type	Description
EntityType	string	['Listing', 'Office', 'BusinessForm', 'User', 'EvaluationForm']
EntityPublicId	string	Entity CasaYes publicId.
EntityReference	string	Entity external reference.
LeadReference	string	Lead publicId.
Source	string	'CasaYes'
CreatedDate	datetime	Lead created date.
Message	string	Lead message.
SenderName	string	Sender name.
SenderEmail	string	Sender email.
SenderPhone	string	Sender phone.
NumberResidents	integer	Projected residents for the apartment .
HasPets	bool	Has
EstimatedDateToMove	string	['Soon', 'Flexible', 'ExactDate']
MonthlyIncome	integer	Monthly income .
PresentationLetter	string	Presentation letter .

Requests

Example

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"
    }