Skip to content
shuffl
Get started

Searches the public product guides only. Nothing from a workspace is read, and questions are not saved.

Reference

Get started API

7 operations. Generated from the OpenAPI document, so this page always matches the API.

OpenAPI documentErrors and rate limitsSDK and CLI recipes

On this page

getStarted.celebration

Read the first-action celebration waiting for you, if any

POST/api/v1/manage/getStarted/celebration

const result = await shuffl.getStarted.celebration();
Request fields (none)

This operation takes no input.

Response null | object

The response is null | object.

getStarted.get

Read your own Get started steps and whether the welcome still shows

POST/api/v1/manage/getStarted/get

const result = await shuffl.getStarted.get();
Request fields (none)

This operation takes no input.

Response object
  • calendarProviders "google" | "microsoft"[] required
  • intro null | string required
  • personId string required
  • showCard boolean required
  • showWizard boolean required
  • steps object[] required
    • done boolean required
    • id "ask" | "calendar" | "communities" | "introduce" | "profile" required

getStarted.celebrate

Record that a celebration was shown, shared or dismissed

POST/api/v1/manage/getStarted/celebrate

const result = await shuffl.getStarted.celebrate({
  "achievement": "<achievement>",
  "outcome": "dismissed",
  "confirm": "getStarted.celebrate",
  "requestKey": "a-new-unique-key"
});
Request fields (5)
  • achievement string required
  • covered string[] optional
  • outcome "dismissed" | "shared" | "shown" required
  • confirm "getStarted.celebrate" required
  • requestKey string required1 to 128 characters
Response object
  • receipt object required
    • completedAt string (date-time) | null required
    • createdAt string (date-time) required
    • id string (uuid) required
    • operation string required
    • requestKey string required
    • status "running" | "succeeded" | "failed" | "unknown" required
  • result object | null required
    • first boolean required
    • kind "badge" | "done" | "hello" | "step" required
    • outcome "dismissed" | "shared" | "shown" required

getStarted.dismiss

Hide the Get started card

POST/api/v1/manage/getStarted/dismiss

  • Write
  • Permission getStarted.dismiss
  • Needs a requestKey
  • Needs confirm set to getStarted.dismiss
const result = await shuffl.getStarted.dismiss({
  "confirm": "getStarted.dismiss",
  "requestKey": "a-new-unique-key"
});
Request fields (2)
  • confirm "getStarted.dismiss" required
  • requestKey string required1 to 128 characters
Response object
  • receipt object required
    • completedAt string (date-time) | null required
    • createdAt string (date-time) required
    • id string (uuid) required
    • operation string required
    • requestKey string required
    • status "running" | "succeeded" | "failed" | "unknown" required
  • result object | null required
    • dismissed boolean required

getStarted.draftIntro

Draft a short hello to your coworkers with Mello; nothing is posted

POST/api/v1/manage/getStarted/draftIntro

const result = await shuffl.getStarted.draftIntro({
  "confirm": "getStarted.draftIntro",
  "requestKey": "a-new-unique-key"
});
Request fields (2)
  • confirm "getStarted.draftIntro" required
  • requestKey string required1 to 128 characters
Response object
  • receipt object required
    • completedAt string (date-time) | null required
    • createdAt string (date-time) required
    • id string (uuid) required
    • operation string required
    • requestKey string required
    • status "running" | "succeeded" | "failed" | "unknown" required
  • result object | null required
    • by "ai" | "rule" required
    • text string required

getStarted.intro

Post your hello on Home, or skip it

POST/api/v1/manage/getStarted/intro

const result = await shuffl.getStarted.intro();
Request fields (none)

This operation takes no input.

Response object
  • receipt object required
    • completedAt string (date-time) | null required
    • createdAt string (date-time) required
    • id string (uuid) required
    • operation string required
    • requestKey string required
    • status "running" | "succeeded" | "failed" | "unknown" required
  • result object | null required
    • Option 1 object optional
      • action "skip" required
      • first boolean required
    • Option 2 object optional
      • action "post" required
      • first boolean required

getStarted.wizard

Record that you opened, finished or skipped the welcome

POST/api/v1/manage/getStarted/wizard

  • Write
  • Permission getStarted.wizard
  • Needs a requestKey
  • Needs confirm set to getStarted.wizard
const result = await shuffl.getStarted.wizard({
  "outcome": "finished",
  "confirm": "getStarted.wizard",
  "requestKey": "a-new-unique-key"
});
Request fields (3)
  • outcome "finished" | "opened" | "skipped" required
  • confirm "getStarted.wizard" required
  • requestKey string required1 to 128 characters
Response object
  • receipt object required
    • completedAt string (date-time) | null required
    • createdAt string (date-time) required
    • id string (uuid) required
    • operation string required
    • requestKey string required
    • status "running" | "succeeded" | "failed" | "unknown" required
  • result object | null required
    • first boolean required