Skip to content
shuffl
Get started

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

Reference

Home API

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

OpenAPI documentErrors and rate limitsSDK and CLI recipes

On this page

home.feed

What happened to people you know, and who Mello thinks you should meet

POST/api/v1/manage/home/feed

const result = await shuffl.home.feed();
Request fields (none)

This operation takes no input.

Response object
  • covers object required
  • items object[] required
    • Option 1 object optional
      • at string (date-time) required
      • date string required
      • eventType "anniversary" | "birthday" required
      • id string required
      • kind "milestone" required
      • person object required
        • id string required
        • name string required
        • photoUrl null | string required
        • slackUserId null | string required
        • title null | string required
        • userId null | string required
      • years null | number required
    • Option 2 object optional
      • at string (date-time) required
      • badge object required
        • automaticKey null | string required
        • id string required
        • imageUrl null | string required
        • kind string required
        • name string required
      • id string required
      • kind "badge" required
      • person object required
        • id string required
        • name string required
        • photoUrl null | string required
        • slackUserId null | string required
        • title null | string required
        • userId null | string required
    • Option 3 object optional
      • at string (date-time) required
      • id string required
      • kind "hello" required
      • person object required
        • id string required
        • name string required
        • photoUrl null | string required
        • slackUserId null | string required
        • title null | string required
        • userId null | string required
      • text string required
    • Option 4 object optional
      • at string (date-time) required
      • channelId null | string required
      • id string required
      • kind "introduced" required
      • people object[] required
        • id string required
        • name string required
        • photoUrl null | string required
        • slackUserId null | string required
        • title null | string required
        • userId null | string required
      • program string required
    • Option 5 object optional
      • at string (date-time) required
      • communities object[] required
        • category "interests" | "places" | "resource_group" | "skills" required
        • coverUrl null | string required
        • id string required
        • name string required
      • id string required
      • kind "community" required
      • people object[] required
        • id string required
        • name string required
        • photoUrl null | string required
        • slackUserId null | string required
        • title null | string required
        • userId null | string required
  • linked boolean required
  • newHires object[] required
    • buddy null | object required
      • id string required
      • name string required
      • photoUrl null | string required
      • slackUserId null | string required
      • title null | string required
      • userId null | string required
    • email null | string required
    • id string required
    • person object required
      • id string required
      • name string required
      • photoUrl null | string required
      • slackUserId null | string required
      • title null | string required
      • userId null | string required
    • sameTeam boolean required
    • startDate string required
    • units string[] required
  • praise object[] required
    • channelId string required
    • channelName string required
    • channelPrivate boolean required
    • giver object required
      • id string required
      • name string required
    • id string required
    • postedAt string (date-time) required
    • reactions object[] required
      • count number required
      • emoji string required
    • reason null | string required
    • recipients object[] required
      • hidden boolean required
      • id string required
      • name string required
    • slackUrl null | string required
    • text string required
    • values string[] required
  • stories object required
    • forYou string[] required
    • preferences object required
      • autoplay boolean required
      • forYou boolean required
      • stories boolean required
      • view "cards" | "compact" required
    • reactions object required
    • views object required
  • suggestions object[] required
    • basis "mutual" | "new" required
    • id string required
    • name string required
    • photoUrl null | string required
    • praised boolean required
    • reasons string[] required
    • score number required
    • shared object[] required
      • id string required
      • name string required
      • photoUrl null | string required
      • slackUserId null | string required
      • title null | string required
      • userId null | string required
    • slackUserId null | string required
    • title null | string required
    • userId null | string required

home.places

The areas turned on for you, what is waiting for you, and your onboarding progress

POST/api/v1/manage/home/places

const result = await shuffl.home.places();
Request fields (none)

This operation takes no input.

Response object
  • places object[] required
    • id "badges" | "celebrations" | "chats" | "communities" | "connections" | "knowledge" | "mentorship" | "playbook" | "praise" | "pulse" required
    • waiting boolean required

home.preferences

Choose how Home looks: cards or compact, stories, autoplay, For you

POST/api/v1/manage/home/preferences

  • Write
  • Permission home.preferences
  • Needs a requestKey
  • Needs confirm set to home.preferences
const result = await shuffl.home.preferences({
  "confirm": "home.preferences",
  "requestKey": "a-new-unique-key"
});
Request fields (6)
  • autoplay false | true optional
  • forYou false | true optional
  • stories false | true optional
  • view "cards" | "compact" optional
  • confirm "home.preferences" 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
    • autoplay boolean required
    • changed "autoplay" | "forYou" | "stories" | "view"[] required
    • forYou boolean required
    • stories boolean required
    • view "cards" | "compact" required

home.react

Add or remove your emoji reaction on a Home moment

POST/api/v1/manage/home/react

  • Write
  • Permission home.react
  • Needs a requestKey
  • Needs confirm set to home.react
const result = await shuffl.home.react({
  "emoji": "cake",
  "itemId": "<itemId>",
  "on": false,
  "confirm": "home.react",
  "requestKey": "a-new-unique-key"
});
Request fields (5)
  • emoji "cake" | "clap" | "heart" | "party" | "wave" required
  • itemId string required
  • on boolean required
  • confirm "home.react" 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
    • counts object required
      • cake number optional
      • clap number optional
      • heart number optional
      • party number optional
      • wave number optional
    • itemId string required
    • mine "cake" | "clap" | "heart" | "party" | "wave"[] required
    • on boolean required
    • people object[] required
      • id string required
      • name string required
      • photoUrl null | string required
      • slackUserId null | string required
      • title null | string required
      • userId null | string required
    • total number required

home.story

Record Home stories you opened, sent a note from, or skipped

POST/api/v1/manage/home/story

  • Write
  • Permission home.story
  • Needs a requestKey
  • Needs confirm set to home.story
const result = await shuffl.home.story({
  "itemIds": [
    "<itemIds>"
  ],
  "outcome": "seen",
  "confirm": "home.story",
  "requestKey": "a-new-unique-key"
});
Request fields (4)
  • itemIds string[] required
  • outcome "seen" | "sent" | "skipped" required
  • confirm "home.story" 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
    • outcome "seen" | "sent" | "skipped" required
    • recorded number required