Kolibri
How Kolibri objects and appointments sync with Sparki.
Add-on
The Kolibri add-on connects Kolibri listings with Sparki projects, and can send confirmed Sparki appointments back to a Kolibri agenda.
Kolibri remains the source for object data. Sparki stores a synced copy so the dashboard can create, link, and refresh customer-facing projects from it.
The Short Version
Kolibri can provide Sparki with object assignments for the portal. Sparki stores those objects as synced Kolibri items, makes them selectable in the dashboard, and uses them to prefill project information such as title, address, price, description, status, images, floor plans, and other listing details.
A synced Kolibri item does not create a Sparki project by itself. A team member links it to a project in the dashboard. After that, future Kolibri updates can refresh the linked Sparki project with the latest synced listing data.
Kolibri object is available or changes
|
v
Sparki syncs the Kolibri object assignment
|
v
Sparki stores or refreshes the synced Kolibri item
|
v
Dashboard creates or updates a linked Sparki project
|
v
Later Kolibri updates can refresh the linked projectBefore You Start
The Kolibri add-on must be available for the portal before it can be configured. If the card is locked or unavailable, contact Sparki support to enable it for the right portal and plan.
You also need the Kolibri connection details for the broker office. The exact values are usually provided by the Kolibri administrator or technical contact:
| Setting | Purpose |
|---|---|
| API base URL | The Kolibri API environment Sparki should use. |
| Authorization token | The secret token Sparki uses to read Kolibri objects and write agenda items. Sparki hides this value after it is saved. |
| Real estate agency ID | The Kolibri agency or organization that owns the synced objects. |
| Office IDs | Optional office filters when only specific offices should be synced. |
| Employee IDs | The Kolibri employees or agenda owners that can receive appointment write-back. |
| Webhook secret | A shared secret used to verify Kolibri change notifications when webhooks are enabled. |
Enabling Kolibri
Open the portal menu and choose Add-ons. Select Kolibri, then complete the connection settings for the portal.
Use the domain toggles to choose what Sparki is allowed to sync:
| Domain | What it controls |
|---|---|
| Listings | Reading Kolibri objects and making them available as project sources. |
| Agenda | Reading or using Kolibri employee and agenda targets for schedule linking. |
| Outbound | Sending confirmed Sparki appointments back to Kolibri. |
After saving, Sparki checks the connection and starts syncing the available Kolibri objects. If mock mode is enabled in a test environment, Sparki uses mock Kolibri data instead of live Kolibri credentials.
Linking Projects
When Kolibri listings are synced, open a Sparki project and choose Kolibri as the project source. Select the correct Kolibri object from the list and save the project.
Sparki stores a hidden Kolibri link on the project. That link keeps the Sparki project connected to the synced Kolibri item, so later object changes can refresh the fields that are managed by Kolibri.
Synced Kolibri item
|
v
Dashboard prefill
|
v
Sparki project fields are filled
|
v
Project is saved with a hidden Kolibri link
|
v
Later Kolibri updates can refresh the linked projectWhat Kolibri Data Goes Where
The table below describes the main visible project fields Sparki fills from a synced Kolibri item.
| Kolibri data | Sparki project field |
|---|---|
| Object title or address label | Project title. |
| Description and public listing text | Project description and long description. |
| Asking price, rent, or price label | Project price. |
| Sale, rental, and availability status | Project transaction type and status. |
| Street, house number, postal code, city, country, and coordinates | Project address and map location. |
| Property type and object details | Project category and detail rows. |
| Images, floor plans, and other public media | Project thumbnail, images, and floor plans. |
Sparki also stores technical Kolibri data that is not shown directly to customers, such as the Kolibri object id, source type, agency id, office or employee context, sync status, and the original synced response. This makes later refreshes and troubleshooting possible.
Updates After Linking
When Kolibri sends a change notification or Sparki runs a sync, Sparki refreshes the synced Kolibri item. If that item is linked to an active Sparki project, Sparki refreshes the project fields managed by the Kolibri source.
If a Kolibri object is withdrawn, deleted, or no longer available for the connected agency, Sparki marks the synced item as inactive. Sparki does not automatically delete customer-facing projects. Review the linked project in the dashboard and decide whether it should stay published, be archived, or be disconnected from the Kolibri source.
Appointments Back to Kolibri
Appointment sync is separate from object sync. It only runs when the Kolibri connection is enabled, the agenda and outbound domains are enabled, and the Sparki schedule is linked to a Kolibri employee or agenda target.
When a confirmed appointment is created in Sparki, Sparki can create a matching item in Kolibri. When that confirmed appointment changes, Sparki can update the Kolibri agenda item. When the appointment is cancelled, Sparki can cancel or update the matching Kolibri item if it was already synced.
Customer books or changes a confirmed appointment in Sparki
|
v
Sparki checks the linked Kolibri agenda target
|
v
Sparki sends create, update, or cancel to Kolibri
|
v
Sparki stores the Kolibri agenda item id for later changesThe appointment data sent to Kolibri can include the schedule target, appointment time, customer name, customer contact details, project title, linked Kolibri object information, and a Sparki appointment reference for traceability.
Webhook URL
Each Kolibri integration has its own webhook URL. The URL uses the integration id, so one portal connection does not accidentally receive updates for another portal connection.
https://api.sparki.app/webhooks/kolibri/v1/{integrationId}Do not copy the example above with {integrationId} still inside it. Open the Kolibri add-on settings in the dashboard and copy the Webhook URL field from there. That field uses the configured Sparki API URL for the current environment.
When webhooks are enabled, Kolibri can notify Sparki when an object assignment or project assignment changes. Sparki verifies the notification with the configured webhook secret before refreshing the affected synced item.
Troubleshooting
If no Kolibri objects are visible, check that the Kolibri add-on is enabled, the listings domain is active, the API details are saved, and the agency or office filters match the objects you expect to see.
If a schedule cannot be connected, check that the agenda domain is active and that the correct employee IDs or agenda targets are configured.
If appointments do not appear in Kolibri, check that the outbound domain is active, the schedule is linked to a Kolibri agenda target, and the appointment is confirmed. Draft, pending, or cancelled appointments that were never synced before do not create new Kolibri agenda items.
If the Kolibri token or webhook secret changes, update the Kolibri add-on settings in Sparki and save them again. Sparki hides saved secret values, so paste the new value instead of relying on the old hidden value.