Listing

Listing Webhook

A notification via webhook is sent whenever a property is created, updated, or removed, provided the CRM subscribes to this functionality. To receive these notifications, the CRM must supply a designated endpoint where the webhook can be directed.

When an event such as the creation, update, or deletion of a property occurs, the system triggers a webhook notification. This notification is then sent to the specified endpoint, allowing the CRM to process and respond to the event in real-time. By subscribing to this feature and providing the necessary endpoint, the CRM ensures that it remains synchronized with the latest property data, facilitating efficient and up-to-date property 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
ListingReference	string	Listing external reference.
ListingPublicId	string	Listing CasaYes publicId.
EventType	string	[ 'LISTING_CREATED', 'LISTING_UPDATED', 'LISTING_DELETED', 'LISTING_FAILED_TO_CREATE', 'LISTING_FAILED_TO_UPDATE', 'LISTING_FAILED_TO_DELETE' ]
Success	boolean	If operation ended with success.
ErrorMessages	string []	Errors that occur during the process.
OfficeIntegrationSecret	string	Office integration secret.
Status	string	[ 'Published', 'Unpublished', 'UnpublishedByAdmin' ]

Requests

Example

Method: POST
Headers: 
    { 
        "token": "0b4ba9b1-8e04-44cc-84ec-eb0579c0bb20"
    }
Body: 
    {
        "ListingPublicId": "KiKJ3LHhHm2Q",
        "EventType": "LISTING_CREATED",
        "Success": true,
        "ErrorMessages": [],
        "OfficeIntegrationSecret": "007_1711534073_BAAAAFB5-577D-4BCE-AAAA-894D1F4EBBBB",
        "Status": "Published"
    }