Events
What changed in the account, in order, with 30 days of history — incremental sync. Events are lean: ids and the names of the changed fields; the detail comes from reading the resource.
- GET/v1/events— What changed
Routes
GET
/v1/eventsWhat changed
The account's events in order, with 30 days of history. Read page by page while hasMore is true; on false, stop and keep nextCursor for the next sync — it always comes, even when there is nothing new (asking again right away returns an empty list and the same cursor). Each type also requires the resource's read permission. An event takes from seconds to over a minute to show up: follow the CURSOR, never the clock.
Permission:
events:readQuery parameters
limitinteger- Items per page: 1 to 500 (default 100).
cursorstring- The
nextCursorfrom the previous page. The list is over when it comes back null. It is only valid for this route and this account. sincestring- Start from this date/time (only without a cursor; in the future, 400).
typesstring- Only these types, comma-separated.
Response200OK
datalist of Eventrequired- The events, in order.
nextCursorstringrequired- Where to continue (always present).
hasMorebooleanrequired- There is more to read right now.
Example
curl -X GET 'https://api.imobyflow.com.br/v1/events' \
-H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
-H 'Accept-Language: en'Errors for this route
Objects
Event
An event.
idstringrequired- Event id (
evt_…) — the samewebhook-idas the delivery. Use it to avoid processing twice. typestringrequired- Type.one of
property.createdproperty.updatedproperty.deletedproperty.restoredproperty.purgedlead.createdlead.updatedlead.deletedlead.restoredlead.purgedradar.client_summarypartnership.createdpartnership.updatedcaptacao.offer_receivedcaptacao.offer_acceptedcaptacao.offer_withdrawn createdAtstringrequired- When it was recorded (UTC).
dataobjectrequired- What changed, lean: ids, state and
changedFields(the NAMES of the changed fields). Never name, phone, e-mail or address — fetch the detail by reading the resource.