Overview

Onboard a rooftop for a Vini service agent (inbound or outbound): sign the contract, work the onboarding checklist, set up the rooftop and its integrations, set up the agent, then go live. Each section lists the APIs to call, in order. After each task is saved, mark it done with the checklist call.

All APIs are on https://api.spyne.ai with the user's bearer token. enterpriseId is the dealer group and teamId is the rooftop.

Sections

Section	What you do there
Contract	Load the contract form, create the contract, send it for signature (DocuSign), hand over to onboarding, schedule the kickoff and create the checklist.
Checklist	Read the contract, product lines, agents bought and the checklist, and mark tasks done.
Rooftop Setup	Rooftop details, departments and holidays, console users, employee directory and brand registration (caller ID).
Integrations	The service scheduler.
Agent Setup	Agent customization, phone number, service policies, call transcripts and recordings, and the chatbot script.
Go-Live	The readiness checklist, then switch the agent live.

By agent

Each agent has its own checklist key (segmentName) and entity.

Agent	`segmentName`	`entity`	Go-live readiness steps
Service inbound	`inboundService`	`service_inbound`	`afterHours`, `officeHoursOverflow`
Service outbound	`outboundService`	`service_outbound`	`runFirstCampaign` only

Order

Contract, then create the checklist.
Rooftop Setup. It is done once per rooftop and shared by every agent.
Integrations: service agents need the service scheduler.
Agent Setup, once per agent.
Go-Live.