x-cpod-domain: clientops
ClientOps
Customer health scores, success playbooks, onboarding plans, retention risk tracking, and expansion pipeline.
Try in explorer
client.clientops.healthScores · client.clientops.playbooks · client.clientops.onboardingPlans · client.clientops.retentionRisks · client.clientops.expansionsHealthScore
Customer health score with contributing factors.
REST path
/api/v1/clientops/health-scoresOperations
listgetcreateupdatedeleteSDK
// list — returns only your records; add filters/search:
await client.clientops.healthScores.healthScores.list()
// create:
await client.clientops.healthScores.healthScores.create({
score: 42,
id: "rec_01HXEXAMPLE",
account_id: "account_01HXEXAMPLE",
trend: "improving",
calculated_at: "2026-01-01T00:00:00Z",
})| Field | Type | Description |
|---|---|---|
| id | uuid | — |
| account_id | uuid→Account | — |
| score* | number | — |
| factors | json | — |
| trend | enum | —improvingstabledeclining |
| calculated_at | date-time | — |
Playbook
A success playbook for customer engagement.
REST path
/api/v1/clientops/playbooksOperations
listgetcreateupdatedeleteSDK
// list — returns only your records; add filters/search:
await client.clientops.healthScores.playbooks.list()
// create:
await client.clientops.healthScores.playbooks.create({
name: "example name",
id: "rec_01HXEXAMPLE",
description: "example description",
})| Field | Type | Description |
|---|---|---|
| id | uuid | — |
| name* | string | — |
| description | string | — |
| trigger_conditions | json | — |
| steps | json | — |
OnboardingPlan
Structured onboarding plan for a customer.
REST path
/api/v1/clientops/onboarding-plansOperations
listgetcreateupdatedeleteSDK
// list — returns only your records; add filters/search:
await client.clientops.healthScores.onboardingPlans.list()
// create:
await client.clientops.healthScores.onboardingPlans.create({
id: "rec_01HXEXAMPLE",
account_id: "account_01HXEXAMPLE",
status: "not_started",
started_at: "2026-01-01T00:00:00Z",
})| Field | Type | Description |
|---|---|---|
| id | uuid | — |
| account_id | uuid→Account | — |
| status | enum | —not_startedin_progresscompletedblocked |
| milestones | json | — |
| started_at | date-time | — |
RetentionRisk
Retention risk flag for an account.
REST path
/api/v1/clientops/retention-riskOperations
listgetcreateupdatedeleteSDK
// list — returns only your records; add filters/search:
await client.clientops.healthScores.retentionRisk.list()
// create:
await client.clientops.healthScores.retentionRisk.create({
id: "rec_01HXEXAMPLE",
account_id: "account_01HXEXAMPLE",
risk_level: "low",
reason: "example reason",
detected_at: "2026-01-01T00:00:00Z",
})| Field | Type | Description |
|---|---|---|
| id | uuid | — |
| account_id | uuid→Account | — |
| risk_level | enum | —lowmediumhighcritical |
| reason | string | — |
| detected_at | date-time | — |
Expansion
Expansion opportunity in the pipeline.
REST path
/api/v1/clientops/expansionsOperations
listgetcreateupdatedeleteSDK
// list — returns only your records; add filters/search:
await client.clientops.healthScores.expansions.list()
// create:
await client.clientops.healthScores.expansions.create({
id: "rec_01HXEXAMPLE",
account_id: "account_01HXEXAMPLE",
type: "upsell",
value: 42,
status: "identified",
})| Field | Type | Description |
|---|---|---|
| id | uuid | — |
| account_id | uuid→Account | — |
| type | enum | —upsellcross_selladd_onrenewal |
| value | number | — |
| status | enum | —identifiedqualifiedproposedwonlost |