Skip to content
shuffl
Get started

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

Reference

Notifications API

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

OpenAPI documentErrors and rate limitsSDK and CLI recipes

On this page

notifications.preferences

Read your notification preferences

POST/api/v1/manage/notifications/preferences

const result = await shuffl.notifications.preferences();
Request fields (none)

This operation takes no input.

Response object
  • groups object[] required
    • id "programs" | "requests" | "shuffl" required
    • kinds "billing_limit" | "celebration" | "check_in" | "connections_intro" | "getting_started" | "hr_digest" | "hr_message" | "hr_reply" | "hr_request" | "legacy_upgrade" | "mentorship" | "outbound_action" | "playbook" | "policy_acknowledgement" | "praise" | "product_updates" | "pulse" | "pulse_results" | "support_new" | "support_reply"[] required
    • title "From Shuffl" | "Programs" | "Requests and support" required
  • preferences object[] required
    • channels "email" | "slack" | "teams"[] required
    • email boolean required
    • kind "billing_limit" | "celebration" | "check_in" | "connections_intro" | "getting_started" | "hr_digest" | "hr_message" | "hr_reply" | "hr_request" | "legacy_upgrade" | "mentorship" | "outbound_action" | "playbook" | "policy_acknowledgement" | "praise" | "product_updates" | "pulse" | "pulse_results" | "support_new" | "support_reply" required
    • slack boolean required
    • teams boolean required
  • slackLinked boolean required

notifications.save

Save a notification preference

POST/api/v1/manage/notifications/save

const result = await shuffl.notifications.save({
  "channel": "email",
  "enabled": false,
  "kind": "billing_limit",
  "requestKey": "a-new-unique-key"
});
Request fields (4)
  • channel "email" | "slack" | "teams" required
  • enabled boolean required
  • kind "billing_limit" | "celebration" | "check_in" | "connections_intro" | "getting_started" | "hr_digest" | "hr_message" | "hr_reply" | "hr_request" | "legacy_upgrade" | "mentorship" | "outbound_action" | "playbook" | "policy_acknowledgement" | "praise" | "product_updates" | "pulse" | "pulse_results" | "support_new" | "support_reply" 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
    • groups object[] required
      • id "programs" | "requests" | "shuffl" required
      • kinds "billing_limit" | "celebration" | "check_in" | "connections_intro" | "getting_started" | "hr_digest" | "hr_message" | "hr_reply" | "hr_request" | "legacy_upgrade" | "mentorship" | "outbound_action" | "playbook" | "policy_acknowledgement" | "praise" | "product_updates" | "pulse" | "pulse_results" | "support_new" | "support_reply"[] required
      • title "From Shuffl" | "Programs" | "Requests and support" required
    • preferences object[] required
      • channels "email" | "slack" | "teams"[] required
      • email boolean required
      • kind "billing_limit" | "celebration" | "check_in" | "connections_intro" | "getting_started" | "hr_digest" | "hr_message" | "hr_reply" | "hr_request" | "legacy_upgrade" | "mentorship" | "outbound_action" | "playbook" | "policy_acknowledgement" | "praise" | "product_updates" | "pulse" | "pulse_results" | "support_new" | "support_reply" required
      • slack boolean required
      • teams boolean required
    • slackLinked boolean required