Introduction
This stage connects a rooftop's service scheduler to Vini. You list the available partners, read what is already saved, save the rooftop's choice, and then mark the checklist task done.
Service agents need the service scheduler.
| Endpoint | Method and path | What it does |
|---|---|---|
| List CRM and scheduler partners | GET /integrations/registry | Lists active CRM, service scheduler or DMS partners. |
| Read a saved integration | GET /central-config/v1/integration | Returns the integration saved for a rooftop and entity, or an empty object. |
| Save the service scheduler integration | POST /console/v1/product-onboarding/integration | Saves the service scheduler partner and registers the partner link. |
Every path starts with https://api.spyne.ai. Send the signed-in console user's session token as Authorization: Bearer YOUR_TOKEN. Read a saved integration has no authentication check.
Which integrations each agent needs
The checklist creates these Integrations tasks per agent segment. When an integration is saved, mark its task done with Mark a checklist task done in the Checklist section, using the exact task name below.
| Agent (checklist segment) | Integration | Mark done as | Pages used |
|---|---|---|---|
| Service inbound, Service outbound | Service scheduler | Service Scheduler | List CRM and scheduler partners, Read, Save |
| Service inbound, Service outbound | DMS (only when the checklist sends it for the segment) | DMS Integration | Not covered in this section. |
The exact task list per segment is stored as configuration data, not in code. Confirm it against the live checklist for each product.
| Save | Task it completes | When the UI marks it done |
|---|---|---|
Save the service scheduler integration with entity: "SERVICE_SCHEDULER" | Service Scheduler | After the save succeeds. |
The UI sends no segmentName, so each task is completed in every segment of the rooftop. None of these saves completes the task on the server; only the separate checklist call does. It is marked done on any successful save and does not check that the partner link was approved or verified.
Order to call them
- Check what is saved. Read a saved integration.
- List partners. List CRM and scheduler partners.
- Save the pick. Save the service scheduler integration with
entity: "SERVICE_SCHEDULER". - Mark the task done as
Service Schedulerwith Mark a checklist task done.
Service only
Every page in this section is common to all agents except Save the service scheduler integration, which is specific to service agents.
Updated about 2 hours ago
