Imóveis

Webhook de Imóveis

É enviada uma notificação via webhook sempre que um imóvel é criado, atualizado ou removido, 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 ocorre um evento como a criação, atualização ou eliminação de um imóvel, o sistema aciona uma notificação webhook. Esta notificação é então enviada para o endpoint especificado, permitindo que o CRM processe e responda ao evento em tempo real. Ao subscrever esta funcionalidade e fornecer o endpoint necessário, o CRM garante que permanece sincronizado com os dados mais recentes dos imóveis, facilitando uma gestão de imóveis eficiente e atualizada.

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

Name
Tipo
Descrição

ListingReference

string

Referência do imóvel.

ListingPublicId

string

Id Público do Imóvel no CasaYes.

EventType

string

[ 'LISTING_CREATED', 'LISTING_UPDATED', 'LISTING_DELETED', 'LISTING_FAILED_TO_CREATE', 'LISTING_FAILED_TO_UPDATE', 'LISTING_FAILED_TO_DELETE' ]

Success

boolean

Se a operação terminou com sucesso.

ErrorMessages

string []

Erros que ocorreram durante o processo.

OfficeIntegrationSecret

string

Segredo de integração da agência.

Status

string

[ 'Published', 'Unpublished', 'UnpublishedByAdmin' ]

Requests

Exemplo

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

Last updated