Integrations

A product's step-by-step connect walkthrough.

Who can connect, what is read, what is never done or included, what the product's own screen shows and how to answer it, how to choose what to bring in, the honest first-check estimate, and — when an admin must approve first — a prefilled message and the approval link. With the organization's live state. The same data the app's Connect drawer renders. Scope: story:read. Free.

get/integrations/providers/{slug}/walkthrough

Request

  • Base URL: https://docs.sleeperhit.studio/api/v1
  • URL: https://docs.sleeperhit.studio/api/v1/integrations/providers/{slug}/walkthrough
  • Auth: HTTP bearer

Response

The walkthrough and the live state.

slugstring required
labelstring required
logoPathstring nullable required
state'READY' | 'COMING_SOON' | 'PENDING' | 'CONNECTED' | 'NEEDS_ATTENTION' | 'RATE_LIMITED' required
adminApprovalUrlstring nullable required

The approval link an admin opens, when the product has one (Microsoft).

readOnlystring required
keepGatestring required

Changes

No recorded changes to this operation across all 1 revision of this API.