Skip to content
shuffl
Get started

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

Reference

Praise API

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

OpenAPI documentErrors and rate limitsSDK and CLI recipes

On this page

praise.composer

Read who you can praise, the praise channels and company values

POST/api/v1/manage/praise/composer

const result = await shuffl.praise.composer();
Request fields (none)

This operation takes no input.

Response object

The response is object.

praise.feed

Read the Praise feed

POST/api/v1/manage/praise/feed

const result = await shuffl.praise.feed({});
Request fields (2)
  • before string | number | boolean | null | string | number | boolean | null | any[] | object[] | object optional
  • limit number optional
Response object
  • items 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
  • next null | string (date-time) required
  • values object[] required
    • count number required
    • value string required

praise.insights

Read Praise totals by value (groups of seven or more)

POST/api/v1/manage/praise/insights

const result = await shuffl.praise.insights({
  "days": "<days>"
});
Request fields (1)
  • days string | number | boolean | null | string | number | boolean | null | any[] | object[] | object required
Response object

The response is object.

praise.mine

Read praise you gave and received

POST/api/v1/manage/praise/mine

const result = await shuffl.praise.mine();
Request fields (none)

This operation takes no input.

Response object

The response is object.

praise.ofPerson

Read the public praise one person received

POST/api/v1/manage/praise/ofPerson

const result = await shuffl.praise.ofPerson({
  "personId": "<personId>"
});
Request fields (1)
  • personId string required
Response object
  • items 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

praise.settings

Read the Praise settings

POST/api/v1/manage/praise/settings

const result = await shuffl.praise.settings();
Request fields (none)

This operation takes no input.

Response object
  • channels object[] required
    • active boolean required
    • addedAt string (date-time) required
    • channelId string required
    • channelName string required
    • importError null | string required
    • imported number required
    • importedAt null | string (date-time) required
    • importStatus "done" | "failed" | "pending" | "running" required
    • introError null | string required
    • introPostedAt null | string (date-time) required
    • isPrivate boolean required
    • membersError null | string required
    • membersFresh boolean required
    • reading number required
  • companyValues string[] required
  • managerNudges boolean required
  • praiseCount number required
  • reaction null | string required
  • reactionError null | string required
  • reactionReadScope boolean required
  • reactionScope boolean required
  • revision number required
  • slack object required
    • reason "connected" | "grid_pending" | "missing_permissions" | "not_installed" | "paused" | "revoked" | "sample_data" | "unavailable" | "uninstalled" | "workspace_changed" required
    • state "connected" | "needs_reconnect" | "not_connected" required
  • status "off" | "on" required
  • valuesPages object[] required
    • id string required
    • published boolean required
    • title string required
  • valuesSource null | object required
    • id string required
    • published boolean required
    • title string required
    • values string[] required
  • valuesSourceId null | string required

praise.addChannel

Read praise from this Slack channel from now on

POST/api/v1/manage/praise/addChannel

  • Write
  • Permission praise.addChannel
  • Needs a requestKey
  • Needs confirm set to praise.addChannel
const result = await shuffl.praise.addChannel({
  "channelId": "<channelId>",
  "confirm": "praise.addChannel",
  "requestKey": "a-new-unique-key"
});
Request fields (3)
  • channelId string required
  • confirm "praise.addChannel" 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
    • added boolean required
    • channelId string required

praise.removeChannel

Stop reading praise from a Slack channel

POST/api/v1/manage/praise/removeChannel

const result = await shuffl.praise.removeChannel({
  "channelId": "<channelId>",
  "confirm": "praise.removeChannel",
  "requestKey": "a-new-unique-key"
});
Request fields (3)
  • channelId string required
  • confirm "praise.removeChannel" 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
    • removed boolean required

praise.saveSettings

Save the Praise settings and company values

POST/api/v1/manage/praise/saveSettings

const result = await shuffl.praise.saveSettings({
  "expectedRevision": 0,
  "status": "off",
  "valuesSourceId": "<valuesSourceId>",
  "confirm": "praise.saveSettings",
  "requestKey": "a-new-unique-key"
});
Request fields (7)
  • expectedRevision number required
  • managerNudges false | true optional
  • reaction null | string optional
  • status "off" | "on" required
  • valuesSourceId null | string required
  • confirm "praise.saveSettings" 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
    • changed boolean required
    • revision number required

praise.send

Praise coworkers in a praise channel

POST/api/v1/manage/praise/send

  • Write
  • Permission praise.send
  • Needs a requestKey
  • Needs confirm set to praise.send
const result = await shuffl.praise.send({
  "channelId": "<channelId>",
  "composerKey": "<composerKey>",
  "recipientIds": [
    "<recipientIds>"
  ],
  "text": "<text>",
  "confirm": "praise.send",
  "requestKey": "a-new-unique-key"
});
Request fields (9)
  • channelId string required
  • composerKey string required
  • from "feed" | "nudge" | "profile" | "slack_manager_nudge" | "slack_reminder" | "slack_thank_back" | "suggestion" | "yours" optional
  • privately false | true optional
  • recipientIds string[] required
  • text string required
  • values string[] optional
  • confirm "praise.send" 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
    • channelId string required
    • notSent string[] required
    • posted boolean required
    • praiseId null | string required
    • privateNotes number required
    • recipients number required
    • replayed boolean required

praise.setDigest

Choose whether you get the daily Praise digest

POST/api/v1/manage/praise/setDigest

  • Write
  • Permission praise.setDigest
  • Needs a requestKey
  • Needs confirm set to praise.setDigest
const result = await shuffl.praise.setDigest({
  "digest": false,
  "confirm": "praise.setDigest",
  "requestKey": "a-new-unique-key"
});
Request fields (3)
  • digest boolean required
  • confirm "praise.setDigest" 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
    • digest boolean required

praise.setHidden

Hide or show a praise you received

POST/api/v1/manage/praise/setHidden

  • Write
  • Permission praise.setHidden
  • Needs a requestKey
  • Needs confirm set to praise.setHidden
const result = await shuffl.praise.setHidden({
  "hidden": false,
  "praiseId": "<praiseId>",
  "confirm": "praise.setHidden",
  "requestKey": "a-new-unique-key"
});
Request fields (4)
  • hidden boolean required
  • praiseId string required
  • confirm "praise.setHidden" 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
    • hidden boolean required

praise.setRecognition

Choose whether praise for you is posted publicly or sent to you privately

POST/api/v1/manage/praise/setRecognition

const result = await shuffl.praise.setRecognition({
  "recognition": "private",
  "confirm": "praise.setRecognition",
  "requestKey": "a-new-unique-key"
});
Request fields (3)
  • recognition "private" | "public" required
  • confirm "praise.setRecognition" 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
    • hidden number required
    • recognition "private" | "public" required