Navegar na documentação

Eventos

O que mudou na conta, em ordem, com 30 dias de memória — a sincronização incremental. O evento é enxuto: ids e os nomes dos campos que mudaram; o detalhe vem da leitura do recurso.

As rotas

GET/v1/events

O que mudou

Os eventos da conta em ordem, com 30 dias de memória. Guarde o nextCursor e mande de volta na próxima leitura — ele sempre vem, também quando não há nada novo. Cada tipo exige também a permissão de leitura do recurso. Um evento leva de segundos a mais de um minuto para aparecer: siga o CURSOR, nunca o relógio.

Permissão: events:read

Filtros e paginação

limitinteger
Itens por página: de 1 a 500 (padrão 100).
cursorstring
O nextCursor da página anterior. A lista acabou quando ele vem nulo. Ele vale só para esta rota e esta conta.
sincestring
Começar desta data/hora (só sem cursor).
typesstring
Só estes tipos, separados por vírgula.

Resposta200OK

datalista de Eventobrigatório
Os eventos, em ordem.
nextCursorstringobrigatório
Onde continuar (sempre vem).
hasMorebooleanobrigatório
Há mais para ler agora.

Exemplo

curl -X GET 'https://api.imobyflow.com.br/v1/events' \
  -H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
  -H 'Accept-Language: pt-BR'

Erros desta rota

E os erros comuns a toda rota

Os objetos

Event

Um evento.

idstringobrigatório
Id do evento (evt_…) — o mesmo webhook-id da entrega. Use-o para não processar duas vezes.
typestringobrigatório
Tipo.um de property.created property.updated property.deleted property.restored property.purged lead.created lead.updated lead.deleted lead.restored lead.purged radar.client_summary partnership.created partnership.updated captacao.offer_received captacao.offer_accepted captacao.offer_withdrawn
createdAtstringobrigatório
Quando foi registrado (UTC).
dataobjetoobrigatório
O que mudou, enxuto: ids, o estado e changedFields (os NOMES dos campos que mudaram). Nunca nome, telefone, e-mail ou endereço — busque o detalhe pela leitura do recurso.