# MCP tool list

> Every tool the Shuffl MCP server can offer, with what it does and the permission that turns it on.

Audience: Agent builders and workspace administrators

Kind: Reference

Canonical: https://shuffl.ai/docs/mcp-tools

<a id="how-tools-work"></a>
## How tools are chosen

Every connection gets the three knowledge tools. Each other tool is one API operation, named after its permission with dots as underscores, and a connection lists only the tools its permissions grant. That is 406 action tools in all.

A tool takes the same input as its API operation, so the REST API reference documents every argument.

Read tools are marked read only. Tools that remove, stop or withdraw something are marked destructive, so clients that honor the mark ask before running them.

- [How action tools work](https://shuffl.ai/docs/mcp#actions)

- [Fields for each operation](https://shuffl.ai/docs/api-reference)

<a id="knowledge-tools"></a>
## Knowledge tools

The MCP permission turns these on for an API key, and every OAuth connection has them.

- `get_team`: Get the connected workspace’s name and id and your current role. Read only. Permission `mcp.knowledge`.

- `search_knowledge`: Search current, approved knowledge you can see. Returns up to eight passages with citation links. Read only. Permission `mcp.knowledge`.

- `get_knowledge_passage`: Read one passage that search_knowledge returned. Read only. Permission `mcp.knowledge`.

<a id="tools-credentials"></a>
## API keys

- `credentials_api_list`: List the workspace's API keys and what each can do. Read only. Permission `credentials.api.list`.

- `credentials_api_create`: Delegate a subset of this credential with bounded expiry and inherited revocation. Write. Permission `credentials.api.create`.

- `credentials_api_revoke`: Revoke an API key. Write, destructive. Permission `credentials.api.revoke`.

- [API keys API reference](https://shuffl.ai/docs/api-reference/credentials)

<a id="tools-badges"></a>
## Badges

- `badges_holders`: List the people who hold a badge, as far as each lets you see. Read only. Permission `badges.holders`.

- `badges_list`: List the team’s badges, who holds them and any open requests you decide. Read only. Permission `badges.list`.

- `badges_ofPerson`: List a person's badges. Read only. Permission `badges.ofPerson`.

- `badges_settings`: Read the badge suggestion settings. Read only. Permission `badges.settings`.

- `badges_award`: Give a badge you own to a person. Write. Permission `badges.award`.

- `badges_claim`: Claim a badge with its code. Write. Permission `badges.claim`.

- `badges_decideRequest`: Approve or decline a request for a badge. Write. Permission `badges.decideRequest`.

- `badges_generatePicture`: Draw an AI picture for a badge you own. Keeps a picture already set unless replace is true; idea says what to draw. Write. Permission `badges.generatePicture`.

- `badges_hideOwn`: Hide or show one of your badges on your profile. Write. Permission `badges.hideOwn`.

- `badges_request`: Ask for a badge. Write. Permission `badges.request`.

- `badges_revoke`: Take a badge back from a person. Write, destructive. Permission `badges.revoke`.

- `badges_save`: Create or edit a badge you own. Write. Permission `badges.save`.

- `badges_saveSettings`: Turn badge offers from praise on or off, and choose the launch channel. Write. Permission `badges.saveSettings`.

- `badges_setHidden`: Hide or show a badge for the whole workspace. Write. Permission `badges.setHidden`.

- `badges_uploadPicture`: Set a badge picture from a PNG, JPEG or WebP picture sent as base64, for a badge you own. Write. Permission `badges.uploadPicture`.

- [Badges API reference](https://shuffl.ai/docs/api-reference/badges)

<a id="tools-celebrations"></a>
## Celebrations

- `celebrations_card`: Open a celebration card you can sign or were given. Read only. Permission `celebrations.card`.

- `celebrations_cards`: List celebration cards to sign and cards you were given. Read only. Permission `celebrations.cards`.

- `celebrations_deliveries`: List the celebration messages Shuffl sent. Read only. Permission `celebrations.deliveries`.

- `celebrations_mine`: List the celebrations you received. Read only. Permission `celebrations.mine`.

- `celebrations_preferences`: Read your birthday and work anniversary sharing preferences. Read only. Permission `celebrations.preferences`.

- `celebrations_preview`: Preview a celebration message. Read only. Permission `celebrations.preview`.

- `celebrations_program`: Read the Celebrations settings. Read only. Permission `celebrations.program`.

- `celebrations_review`: Review upcoming birthdays and work anniversaries. Read only. Permission `celebrations.review`.

- `celebrations_startDates`: Read which start date anniversaries count from and the start dates that look wrong. Read only. Permission `celebrations.startDates`.

- `celebrations_thisWeek`: List who was celebrated in a channel in the last seven days. Read only. Permission `celebrations.thisWeek`.

- `celebrations_refresh`: Look for new birthdays and work anniversaries to celebrate now. Write. Permission `celebrations.refresh`.

- `celebrations_removeCardNote`: Remove your note from this celebration card. Write. Permission `celebrations.removeCardNote`.

- `celebrations_save`: Save celebration settings; enabling them schedules messages. Write. Permission `celebrations.save`.

- `celebrations_saveAnniversaryDate`: Choose which start date work anniversaries count from; reschedules them. Write. Permission `celebrations.saveAnniversaryDate`.

- `celebrations_savePreferences`: Save your birthday and work anniversary sharing preferences. Write. Permission `celebrations.savePreferences`.

- `celebrations_signCard`: Sign this celebration card with your note. Write. Permission `celebrations.signCard`.

- [Celebrations API reference](https://shuffl.ai/docs/api-reference/celebrations)

<a id="tools-commands"></a>
## Command receipts

- `commands_get`: Read your own command receipt. Read only. Permission `commands.get`.

- [Command receipts API reference](https://shuffl.ai/docs/api-reference/commands)

<a id="tools-communities"></a>
## Communities

- `communities_channelSuggestions`: List Slack channels, with the ones that look like communities suggested. Read only. Permission `communities.channelSuggestions`.

- `communities_createCapabilities`: Read the current permission to create public or private community channels. Read only. Permission `communities.createCapabilities`.

- `communities_list`: List communities with the members you may see. Read only. Permission `communities.list`.

- `communities_members`: List a community's members. Read only. Permission `communities.members`.

- `communities_ofPerson`: List the communities a person belongs to. Read only. Permission `communities.ofPerson`.

- `communities_archive`: Archive a community. Write, destructive. Permission `communities.archive`.

- `communities_createSlackChannel`: Create an explicitly public or private Slack channel as an authorized community owner or administrator, retaining its request id across retries. Write. Permission `communities.createSlackChannel`.

- `communities_fromChannels`: Create one community per chosen Slack channel, as an administrator. Write. Permission `communities.fromChannels`.

- `communities_generateCover`: Draw an AI cover for a community, as its owner, moderator or an administrator. Keeps a cover already set unless replace is true; idea says what to draw. Write. Permission `communities.generateCover`.

- `communities_invite`: Invite selected people to a community as its owner or administrator; each person must accept. Write. Permission `communities.invite`.

- `communities_join`: Join a community. Write. Permission `communities.join`.

- `communities_leave`: Leave a community. Write. Permission `communities.leave`.

- `communities_removeMember`: Remove someone from a community, as its owner or moderator. Write. Permission `communities.removeMember`.

- `communities_revokeInvitation`: Revoke a pending community invitation as its owner or administrator. Write. Permission `communities.revokeInvitation`.

- `communities_save`: Create or edit a community, optionally tied to a Slack channel. Write. Permission `communities.save`.

- `communities_setVisibility`: Show or hide a community on your profile. Write. Permission `communities.setVisibility`.

- `communities_sync`: Sync a community's members with its Slack channel now. Write. Permission `communities.sync`.

- `communities_uploadCover`: Set a community cover from a PNG, JPEG or WebP picture sent as base64, as its owner, moderator or an administrator. Write. Permission `communities.uploadCover`.

- [Communities API reference](https://shuffl.ai/docs/api-reference/communities)

<a id="tools-programs"></a>
## Connections programs

- `programs_communities`: List communities a Connections program can take its people from, with how many members show each one on their profile. Read only. Permission `programs.communities`.

- `programs_get`: Read a program. Read only. Permission `programs.get`.

- `programs_list`: List programs. Read only. Permission `programs.list`.

- `programs_options`: List program setting choices. Read only. Permission `programs.options`.

- `programs_people`: List the people in a program and whether they take part. Read only. Permission `programs.people`.

- `programs_preview`: Preview matches without sending. Read only. Permission `programs.preview`.

- `programs_schedulePreview`: Preview a program's upcoming rounds. Read only. Permission `programs.schedulePreview`.

- `programs_archive`: Archive a program. Write, destructive. Permission `programs.archive`.

- `programs_create`: Create a program. Write. Permission `programs.create`.

- `programs_joinChannel`: Add Shuffl to this public Slack channel. Write. Permission `programs.joinChannel`.

- `programs_pause`: Pause a Connections program and its introductions. Write, destructive. Permission `programs.pause`.

- `programs_resume`: Activate a program and schedule. Write. Permission `programs.resume`.

- `programs_syncRoster`: Refresh channel membership. Write. Permission `programs.syncRoster`.

- `programs_update`: Update a program. Write. Permission `programs.update`.

- [Connections programs API reference](https://shuffl.ai/docs/api-reference/programs)

<a id="tools-runs"></a>
## Connections rounds

- `runs_details`: Read one introduction round and its pairs. Read only. Permission `runs.details`.

- `runs_get`: Read a run status. Read only. Permission `runs.get`.

- `runs_list`: List a program's introduction rounds. Read only. Permission `runs.list`.

- `runs_dispatch`: Dispatch this queued introduction run. Write. Permission `runs.dispatch`.

- `runs_request`: Request introductions from a preview. Write. Permission `runs.request`.

- `runs_retry`: Retry introduction delivery. Write. Permission `runs.retry`.

- `runs_stopKnownFailures`: Stop retrying known failed deliveries and advance the preserved monthly schedule. Write, destructive. Permission `runs.stopKnownFailures`.

- `runs_history_get`: Read one introduction round imported from the previous Shuffl. Read only. Permission `runs.history.get`.

- `runs_history_list`: List introduction rounds imported from the previous Shuffl. Read only. Permission `runs.history.list`.

- [Connections rounds API reference](https://shuffl.ai/docs/api-reference/runs)

<a id="tools-units"></a>
## Departments

- `units_list`: List the departments in the People directory. Read only. Permission `units.list`.

- [Departments API reference](https://shuffl.ai/docs/api-reference/units)

<a id="tools-sync"></a>
## Directory sync

- `sync_current`: Read the People sync provider, its last sync and what it found. Read only. Permission `sync.current`.

- `sync_groups`: List this source’s groups and which ones come into Shuffl. Read only. Permission `sync.groups`.

- `sync_connect`: Connect a directory sync provider with the credential given. Write. Permission `sync.connect`.

- `sync_disconnect`: Disconnect this directory sync provider. Write, destructive. Permission `sync.disconnect`.

- `sync_request`: Ask for a People sync provider Shuffl does not support yet. Write. Permission `sync.request`.

- `sync_run`: Sync People from the connected provider now. Write. Permission `sync.run`.

- `sync_setGroup`: Change which of this source’s groups come into Shuffl. Write. Permission `sync.setGroup`.

- `sync_setWrites`: Let Mello file requests in this source, or stop it. Write. Permission `sync.setWrites`.

- [Directory sync API reference](https://shuffl.ai/docs/api-reference/sync)

<a id="tools-access"></a>
## Employee access

- `access_get`: Read one person's workspace role and app access. Read only. Permission `access.get`.

- `access_slackWaiting`: List Slack members waiting for access to Shuffl. Read only. Permission `access.slackWaiting`.

- `access_enableSlack`: Give these Slack people employee access. Write. Permission `access.enableSlack`.

- `access_save`: Change employee product access. Write. Permission `access.save`.

- `access_saveRole`: Change a member’s team role. Write. Permission `access.saveRole`.

- [Employee access API reference](https://shuffl.ai/docs/api-reference/access)

<a id="tools-exports"></a>
## Exports

- `exports_team`: Export the workspace's programs, people and introduction history. Read only. Permission `exports.team`.

- [Exports API reference](https://shuffl.ai/docs/api-reference/exports)

<a id="tools-get-started"></a>
## Get started

- `getStarted_celebration`: Read the first-action celebration waiting for you, if any. Read only. Permission `getStarted.celebration`.

- `getStarted_get`: Read your own Get started steps and whether the welcome still shows. Read only. Permission `getStarted.get`.

- `getStarted_celebrate`: Record that a celebration was shown, shared or dismissed. Write. Permission `getStarted.celebrate`.

- `getStarted_dismiss`: Hide the Get started card. Write. Permission `getStarted.dismiss`.

- `getStarted_draftIntro`: Draft a short hello to your coworkers with Mello; nothing is posted. Write. Permission `getStarted.draftIntro`.

- `getStarted_intro`: Post your hello on Home, or skip it. Write. Permission `getStarted.intro`.

- `getStarted_wizard`: Record that you opened, finished or skipped the welcome. Write. Permission `getStarted.wizard`.

- [Get started API reference](https://shuffl.ai/docs/api-reference/get-started)

<a id="tools-groups"></a>
## Groups

- `groups_allAutomations`: Every join and leave automation in the workspace: group automations with their group and last runs, playbooks that start on each start date or each last day (`dayZero`) and Connections programs whose people are a group; or only those that start one playbook, program or community. Read only. Permission `groups.allAutomations`.

- `groups_automationChoices`: The Pulse questions, badges and Shuffl lists a group automation can ask, give or add people to. Read only. Permission `groups.automationChoices`.

- `groups_automationInsights`: Group automation runs over the last `days` (30, 90 or 180) against the period before: done, skipped and failed, people reached, by week and kind, the top reasons a run did nothing, runs still scheduled and automations on; `groupId` narrows it. Read only. Permission `groups.automationInsights`.

- `groups_automationRuns`: Every group automation run in the workspace, newest first, 50 at a time (`next` is the cursor for the page after), with `counts` by outcome; `outcome` and `groupId` narrow it. Read only. Permission `groups.automationRuns`.

- `groups_automations`: A group’s automations (what happens when someone joins or leaves) and their last runs. Read only. Permission `groups.automations`.

- `groups_directory`: List the groups shown on profiles, yours first, with a few faces each. Read only. Permission `groups.directory`.

- `groups_directoryGroup`: Read one group shown on profiles and everyone in it. Read only. Permission `groups.directoryGroup`.

- `groups_export`: A group’s members as a CSV file: name, email, title, department, manager and when they joined. Read only. Permission `groups.export`.

- `groups_get`: Read one group: its rules, members and recent entries and exits. Read only. Permission `groups.get`.

- `groups_glance`: One group at a glance: size, joins, departments, tenure and time zones. Read only. Permission `groups.glance`.

- `groups_list`: List the workspace’s groups with who is in each. Read only. Permission `groups.list`.

- `groups_members`: One page of a group’s members. Read only. Permission `groups.members`.

- `groups_message`: One message to a group: its words, who it would reach now and how it reads to one member. Read only. Permission `groups.message`.

- `groups_messages`: The drafts and sends of messages to a group, newest first. Read only. Permission `groups.messages`.

- `groups_options`: The departments, teams, communities, programs, titles, locations and time zones a rule may name. Read only. Permission `groups.options`.

- `groups_preview`: Count and sample who a set of rules would hold today. Read only. Permission `groups.preview`.

- `groups_searchPeople`: Find people by name to pick for a group. Read only. Permission `groups.searchPeople`.

- `groups_suggestions`: Starter groups not made yet, with how many people each would hold. Read only. Permission `groups.suggestions`.

- `groups_discardMessage`: Drop a drafted message to a group. Write. Permission `groups.discardMessage`.

- `groups_prepareMessage`: Write a message to everyone in a group and see who it would reach; nothing is sent. Write. Permission `groups.prepareMessage`.

- `groups_refresh`: Re-evaluate a dynamic group’s rules now. Write. Permission `groups.refresh`.

- `groups_remove`: Remove a group. Write. Permission `groups.remove`.

- `groups_removeAutomation`: Remove an automation from a group, with its runs. Write. Permission `groups.removeAutomation`.

- `groups_save`: Create or change a group or a department: a list of people or rules that keep it up to date. Write. Permission `groups.save`.

- `groups_sendMessage`: Send a drafted message to a group once per request key, on each person’s chosen channel. Write. Permission `groups.sendMessage`.

- `groups_setAutomation`: Add or change an automation on a group: send a message, ask a Pulse question, start a playbook, invite to a community, add to Connections, give a badge, add to or remove from another group, add to or post in a Slack channel (`config.channelId`, read back from Slack), or tell HR, their manager or someone named, right away or days later; a new one starts paused. Write. Permission `groups.setAutomation`.

- `groups_setAutomationState`: Pause or resume an automation on a group. Write. Permission `groups.setAutomationState`.

- `groups_setPlaybookAutoStart`: Turn on, pause or remove a playbook’s automation that starts it on each new hire’s start date, or a leaving playbook’s on each last day, for everyone or one group. Write. Permission `groups.setPlaybookAutoStart`.

- [Groups API reference](https://shuffl.ai/docs/api-reference/groups)

<a id="tools-home"></a>
## Home

- `home_feed`: What happened to people you know, and who Mello thinks you should meet. Read only. Permission `home.feed`.

- `home_places`: The areas turned on for you, what is waiting for you, and your onboarding progress. Read only. Permission `home.places`.

- `home_preferences`: Choose how Home looks: cards or compact, stories, autoplay, For you. Write. Permission `home.preferences`.

- `home_react`: Add or remove your emoji reaction on a Home moment. Write. Permission `home.react`.

- `home_story`: Record Home stories you opened, sent a note from, or skipped. Write. Permission `home.story`.

- [Home API reference](https://shuffl.ai/docs/api-reference/home)

<a id="tools-digest"></a>
## HR digest and nudges

- `digest_culture`: List the Culture page’s recommendations in order and what happened after each one acted on. Read only. Permission `digest.culture`.

- `digest_nudge`: Read one of Mello’s culture nudges. Read only. Permission `digest.nudge`.

- `digest_nudges`: List Mello’s culture nudges for the workspace. Read only. Permission `digest.nudges`.

- `digest_preview`: Preview the HR digest for the last period. Read only. Permission `digest.preview`.

- `digest_settings`: Read the HR digest schedule. Read only. Permission `digest.settings`.

- `digest_actOnNudge`: Record that a culture nudge was acted on and get where its action goes. Write. Permission `digest.actOnNudge`.

- `digest_dismissNudge`: Dismiss a culture nudge for 90 days. Write. Permission `digest.dismissNudge`.

- `digest_saveSettings`: Save the HR digest schedule and admin channel. Write. Permission `digest.saveSettings`.

- [HR digest and nudges API reference](https://shuffl.ai/docs/api-reference/digest)

<a id="tools-hr"></a>
## HR requests

- `hr_categories`: Read the HR request categories and response target. Read only. Permission `hr.categories`.

- `hr_get`: Read one HR request and its messages. Read only. Permission `hr.get`.

- `hr_list`: List the HR requests you asked or can answer. Read only. Permission `hr.list`.

- `hr_mine`: List the HR requests you asked, with HR’s latest reply. Read only. Permission `hr.mine`.

- `hr_readiness`: Check whether HR requests have a destination and someone to answer them. Read only. Permission `hr.readiness`.

- `hr_settings`: Read the HR team name and who answers HR requests. Read only. Permission `hr.settings`.

- `hr_shareSources`: List your recent Mello conversations that an HR request can include. Read only. Permission `hr.shareSources`.

- `hr_command`: Claim, release, reply to, note, categorize, resolve or reopen an HR request. Write. Permission `hr.command`.

- `hr_configure`: Change the HR request destination. Write. Permission `hr.configure`.

- `hr_deliver`: Deliver your HR reply to the employee. Write. Permission `hr.deliver`.

- `hr_rebuildCategories`: Have Mello rebuild the HR request categories from published Knowledge. Write. Permission `hr.rebuildCategories`.

- `hr_renameTeam`: Rename the HR team employees send requests to. Write. Permission `hr.renameTeam`.

- `hr_retryDelivery`: Retry HR request delivery. Write. Permission `hr.retryDelivery`.

- `hr_saveCategories`: Save the HR request categories, their owners and the response target. Write. Permission `hr.saveCategories`.

- `hr_share`: Share this request with the selected HR responders. Write. Permission `hr.share`.

- [HR requests API reference](https://shuffl.ai/docs/api-reference/hr)

<a id="tools-integrations"></a>
## Integrations

- `integrations_authorize`: Get the link that connects Slack, Google Drive or Notion to the workspace. Read only. Permission `integrations.authorize`.

- [Integrations API reference](https://shuffl.ai/docs/api-reference/integrations)

<a id="tools-invitations"></a>
## Invitations

- `invitations_candidates`: List people in the directory who can be invited to the workspace. Read only. Permission `invitations.candidates`.

- `invitations_list`: List pending workspace invitations. Read only. Permission `invitations.list`.

- `invitations_cancel`: Cancel a pending workspace invitation. Write, destructive. Permission `invitations.cancel`.

- `invitations_create`: Invite this person with the selected team role. Write. Permission `invitations.create`.

- `invitations_createMany`: Invite these people with the selected team role. Write. Permission `invitations.createMany`.

- `invitations_inviteDirectory`: Invite everyone in the directory who is not invited yet. Write. Permission `invitations.inviteDirectory`.

- [Invitations API reference](https://shuffl.ai/docs/api-reference/invitations)

<a id="tools-knowledge"></a>
## Knowledge

- `knowledge_context`: Read nearby approved passages. Read only. Permission `knowledge.context`.

- `knowledge_acknowledgements_mine`: List the Knowledge pages you are asked to read and confirm. Read only. Permission `knowledge.acknowledgements.mine`.

- `knowledge_acknowledgements_status`: See who has confirmed a Knowledge page and who has not. Read only. Permission `knowledge.acknowledgements.status`.

- `knowledge_acknowledgements_close`: Stop asking people to confirm this page. Write, destructive. Permission `knowledge.acknowledgements.close`.

- `knowledge_acknowledgements_remind`: Message the people who have not confirmed this page yet. Write. Permission `knowledge.acknowledgements.remind`.

- `knowledge_acknowledgements_request`: Ask the people who can read this page to confirm they read it, and message them. Write. Permission `knowledge.acknowledgements.request`.

- `knowledge_connections_browse`: List documents a connected Knowledge source can see. Read only. Permission `knowledge.connections.browse`.

- `knowledge_connections_list`: List connected Knowledge providers. Read only. Permission `knowledge.connections.list`.

- `knowledge_connections_requests`: List requests to connect a Knowledge source. Read only. Permission `knowledge.connections.requests`.

- `knowledge_connections_connect`: Connect a Knowledge provider with a token. Write. Permission `knowledge.connections.connect`.

- `knowledge_connections_disconnect`: Disconnect a knowledge provider. Write, destructive. Permission `knowledge.connections.disconnect`.

- `knowledge_connections_request`: Ask an administrator to connect a Knowledge source. Write. Permission `knowledge.connections.request`.

- `knowledge_handbook_export`: Download the pages published to everyone as one handbook, in Markdown. Read only. Permission `knowledge.handbook.export`.

- `knowledge_policies_coverage`: Check which common HR policies Knowledge covers. Read only. Permission `knowledge.policies.coverage`.

- `knowledge_sources_get`: Read a Knowledge source. Read only. Permission `knowledge.sources.get`.

- `knowledge_sources_history`: List a Knowledge source's versions. Read only. Permission `knowledge.sources.history`.

- `knowledge_sources_list`: List Knowledge sources. Read only. Permission `knowledge.sources.list`.

- `knowledge_sources_search`: Search Knowledge sources by title. Read only. Permission `knowledge.sources.search`.

- `knowledge_sources_archive`: Archive an unpublished knowledge source. Write, destructive. Permission `knowledge.sources.archive`.

- `knowledge_sources_changeAudience`: Change who can read this knowledge source. Write. Permission `knowledge.sources.changeAudience`.

- `knowledge_sources_importConnected`: Import a document from a connected Knowledge source. Write. Permission `knowledge.sources.importConnected`.

- `knowledge_sources_importWebsite`: Import a website page into Knowledge for review. Write. Permission `knowledge.sources.importWebsite`.

- `knowledge_sources_publish`: Publish this knowledge version to its audience. Write. Permission `knowledge.sources.publish`.

- `knowledge_sources_refresh`: Refresh a Knowledge source from its connected provider. Write. Permission `knowledge.sources.refresh`.

- `knowledge_sources_restore`: Restore an archived knowledge source. Write. Permission `knowledge.sources.restore`.

- `knowledge_sources_save`: Save a Knowledge source draft. Write. Permission `knowledge.sources.save`.

- `knowledge_sources_withdraw`: Withdraw a published Knowledge source. Write, destructive. Permission `knowledge.sources.withdraw`.

- `knowledge_sources_write`: Write a Knowledge page with Mello from its title and a request; nothing is saved. Write. Permission `knowledge.sources.write`.

- `knowledge_templates_facts`: Read what Shuffl knows that policy templates ask for. Read only. Permission `knowledge.templates.facts`.

- `knowledge_templates_draft`: Draft a policy template with Mello, researching each value; nothing is saved. Write. Permission `knowledge.templates.draft`.

- `knowledge_uploads_get`: Read the progress of a Knowledge file upload. Read only. Permission `knowledge.uploads.get`.

- `knowledge_uploads_appendPart`: Upload the next part of a Knowledge file. Write. Permission `knowledge.uploads.appendPart`.

- `knowledge_uploads_complete`: Finish a Knowledge file upload and start reading it. Write. Permission `knowledge.uploads.complete`.

- `knowledge_uploads_create`: Start uploading a file to Knowledge. Write. Permission `knowledge.uploads.create`.

- `knowledge_uploads_retry`: Retry reading a Knowledge file that failed. Write. Permission `knowledge.uploads.retry`.

- [Knowledge API reference](https://shuffl.ai/docs/api-reference/knowledge)

<a id="tools-identities"></a>
## Linked accounts

- `identities_list`: List the Slack and web accounts linked to a person. Read only. Permission `identities.list`.

- `identities_slackAccounts`: List Slack accounts that can be linked to people. Read only. Permission `identities.slackAccounts`.

- `identities_webAccounts`: List web accounts that can be linked to people. Read only. Permission `identities.webAccounts`.

- `identities_linkSlack`: Link a verified Slack account. Write. Permission `identities.linkSlack`.

- `identities_linkWeb`: Link a verified web account. Write. Permission `identities.linkWeb`.

- `identities_unlink`: Revoke an employee identity link. Write, destructive. Permission `identities.unlink`.

- [Linked accounts API reference](https://shuffl.ai/docs/api-reference/identities)

<a id="tools-manager"></a>
## Manager context

- `manager_current`: Read your own manager context. Read only. Permission `manager.current`.

- [Manager context API reference](https://shuffl.ai/docs/api-reference/manager)

<a id="tools-assistant"></a>
## Mello conversations

- `assistant_conversations`: List your conversations with Mello. Read only. Permission `assistant.conversations`.

- `assistant_history`: Read the messages in one of your conversations with Mello. Read only. Permission `assistant.history`.

- `assistant_delete`: Delete one of your conversations with Mello. Write, destructive. Permission `assistant.delete`.

- `assistant_send`: Ask Mello a question in a conversation. Write. Permission `assistant.send`.

- `assistant_stop`: Stop an answer Mello is still writing. Write, destructive. Permission `assistant.stop`.

- [Mello conversations API reference](https://shuffl.ai/docs/api-reference/assistant)

<a id="tools-mentorship"></a>
## Mentorship

- `mentorship_mine`: Your mentorship programs and pairings, with goals and check-ins. Read only. Permission `mentorship.mine`.

- `mentorship_join`: Join a mentorship program as a mentor or mentee, saying what you can help with or want to learn. Write. Permission `mentorship.join`.

- `mentorship_leave`: Leave a mentorship program as a mentor or mentee. Write. Permission `mentorship.leave`.

- `mentorship_checkIns_answer`: Answer whether you met your mentor or mentee, and whether it helped. Write. Permission `mentorship.checkIns.answer`.

- `mentorship_goals_remove`: Remove a goal from your mentorship, as the mentee. Write. Permission `mentorship.goals.remove`.

- `mentorship_goals_save`: Add, rename or check off a goal in your mentorship, as the mentee. Write. Permission `mentorship.goals.save`.

- `mentorship_members_setStatus`: Take someone off a mentorship program, or put them back. Write. Permission `mentorship.members.setStatus`.

- `mentorship_mentors_choose`: Choose your mentor from the mentors Shuffl suggests, in a program where mentees choose. Write. Permission `mentorship.mentors.choose`.

- `mentorship_pairs_decide`: Approve a suggested mentorship pair, which introduces them, or skip it. Write. Permission `mentorship.pairs.decide`.

- `mentorship_pairs_end`: End a mentorship pairing early. Write. Permission `mentorship.pairs.end`.

- `mentorship_pairs_setMine`: Pause, resume or end your own mentorship pairing. Write. Permission `mentorship.pairs.setMine`.

- `mentorship_pairs_suggest`: Suggest a mentor outside their reporting line for every mentee still waiting. Write. Permission `mentorship.pairs.suggest`.

- `mentorship_programs_get`: One mentorship program: who joined, the suggested pairs and whether pairs are meeting. Read only. Permission `mentorship.programs.get`.

- `mentorship_programs_list`: List mentorship programs, with how many mentors, mentees and pairs each has. Read only. Permission `mentorship.programs.list`.

- `mentorship_programs_save`: Create or change a mentorship program: who can join, how long pairings last and how often pairs check in. Write. Permission `mentorship.programs.save`.

- `mentorship_programs_setStatus`: Turn mentorship programs on, pause one, or archive one and end its pairs. Write. Permission `mentorship.programs.setStatus`.

- `mentorship_requests_answer`: Accept or pass on a mentee who chose you as their mentor. Write. Permission `mentorship.requests.answer`.

- `mentorship_sessions_remove`: Remove your notes from a mentorship meeting. Write. Permission `mentorship.sessions.remove`.

- `mentorship_sessions_save`: Add or change your notes from a mentorship meeting: what you talked about and one thing to try. Write. Permission `mentorship.sessions.save`.

- `mentorship_settings_get`: What a new mentorship program starts with: pairing length, check-in cadence and mentees per mentor. Read only. Permission `mentorship.settings.get`.

- `mentorship_settings_save`: Change what a new mentorship program starts with; existing programs keep their own terms. Write. Permission `mentorship.settings.save`.

- [Mentorship API reference](https://shuffl.ai/docs/api-reference/mentorship)

<a id="tools-network"></a>
## Network

- `network_introductions`: Your Connections programs, when your next introduction goes out, and who you met. Read only. Permission `network.introductions`.

- `network_mine`: Who you know and who you should meet. Read only. Permission `network.mine`.

- `network_ofPerson`: People you and this person both know. Read only. Permission `network.ofPerson`.

- `network_orgChart`: Everyone in the team with their manager, for the org chart. Read only. Permission `network.orgChart`.

- `network_claim`: Say you know someone or would like to meet them. Write. Permission `network.claim`.

- `network_requestIntro`: Ask someone you both know to introduce you. Write. Permission `network.requestIntro`.

- [Network API reference](https://shuffl.ai/docs/api-reference/network)

<a id="tools-notifications"></a>
## Notifications

- `notifications_preferences`: Read your notification preferences. Read only. Permission `notifications.preferences`.

- `notifications_save`: Save a notification preference. Write. Permission `notifications.save`.

- [Notifications API reference](https://shuffl.ai/docs/api-reference/notifications)

<a id="tools-operations"></a>
## Operations and audit

- `operations_activity`: Read the workspace's recent audit activity. Read only. Permission `operations.activity`.

- `operations_status`: Read the workspace delivery and provider health summary. Read only. Permission `operations.status`.

- `operations_dispatchInbox`: Resume already-admitted team provider events and support delivery. Write. Permission `operations.dispatchInbox`.

- `operations_reconcile`: Reconcile an externally verified delivery outcome. Write. Permission `operations.reconcile`.

- [Operations and audit API reference](https://shuffl.ai/docs/api-reference/operations)

<a id="tools-users"></a>
## People

- `users_activity`: Read a person's recent activity in Shuffl. Read only. Permission `users.activity`.

- `users_blockedPairs`: List pairs of people who are never introduced. Read only. Permission `users.blockedPairs`.

- `users_details`: Read one person's People directory record. Read only. Permission `users.details`.

- `users_filterOptions`: List the teams, departments, managers and locations People can filter by. Read only. Permission `users.filterOptions`.

- `users_get`: Read a person. Read only. Permission `users.get`.

- `users_glance`: Headcount, growth, departments, tenure and time zones, and where you fit. Read only. Permission `users.glance`.

- `users_list`: List people. Read only. Permission `users.list`.

- `users_managerHistory`: Read a person's recorded manager history. Read only. Permission `users.managerHistory`.

- `users_managers`: List the managers in the People directory. Read only. Permission `users.managers`.

- `users_page`: List people in the People directory: search, or filter by team, department, manager, location, access or workspace role such as owner, admin or HR responder. Read only. Permission `users.page`.

- `users_participants`: List the people who take part in programs. Read only. Permission `users.participants`.

- `users_reportingLineProposal`: Read the reporting lines Mello proposed that wait for review. Read only. Permission `users.reportingLineProposal`.

- `users_assignManagers`: Set the manager of several people at once. Write. Permission `users.assignManagers`.

- `users_blockPair`: Stop two people from being introduced to each other. Write, destructive. Permission `users.blockPair`.

- `users_participation`: Opt a person in to or out of a program. Write. Permission `users.participation`.

- `users_profile`: Edit a person's profile as an administrator. Write. Permission `users.profile`.

- `users_proposeReportingLines`: Ask Mello to propose managers for people without one; nothing changes until reviewed. Write. Permission `users.proposeReportingLines`.

- `users_reviewReportingLines`: Approve chosen proposed reporting lines and close the proposal. Write. Permission `users.reviewReportingLines`.

- `users_save`: Change someone's People directory record as an administrator: name, job title, manager, team, department or start date. Write. Permission `users.save`.

- [People API reference](https://shuffl.ai/docs/api-reference/users)

<a id="tools-playbooks"></a>
## Playbooks

- `playbooks_buddyCandidates`: Suggested buddies for a new hire: outside their reporting line, volunteers first, with how many hires each is buddying. Read only. Permission `playbooks.buddyCandidates`.

- `playbooks_buddyFollowUps`: Your "did you meet?" questions about a new hire or buddy you were paired with. Read only. Permission `playbooks.buddyFollowUps`.

- `playbooks_buddyProgram`: Buddy volunteers and recent buddies, with how many of their hires said they met and how many never did. Read only. Permission `playbooks.buddyProgram`.

- `playbooks_buddySuggestions`: Suggest coworkers who could be your onboarding buddy. Read only. Permission `playbooks.buddySuggestions`.

- `playbooks_candidates`: List people who could be enrolled in onboarding. Read only. Permission `playbooks.candidates`.

- `playbooks_enrollmentPreview`: Preview enrolling a new hire in onboarding. Read only. Permission `playbooks.enrollmentPreview`.

- `playbooks_firstDaysCheckIns`: Your open 30, 60 or 90-day or one-year new hire check-in. Read only. Permission `playbooks.firstDaysCheckIns`.

- `playbooks_firstDaysResults`: What new hires said in their first 90 days check-ins, combined. Read only. Permission `playbooks.firstDaysResults`.

- `playbooks_mine`: Read your own onboarding plan and buddy asks. Read only. Permission `playbooks.mine`.

- `playbooks_person`: Read a new hire's onboarding plan. Read only. Permission `playbooks.person`.

- `playbooks_plans`: The 30/60/90 plans for new hires you manage, and your own once your manager shares it. Read only. Permission `playbooks.plans`.

- `playbooks_previewAs`: Which steps of a playbook one person would get, on which day, and why each skipped step is left out. Read only. Permission `playbooks.previewAs`.

- `playbooks_program`: Read the Onboarding program settings. Read only. Permission `playbooks.program`.

- `playbooks_run`: One of your playbooks (onboarding or another): day 0, buddy, manager, upcoming check-ins, your to-dos and resources, and the other playbooks you are on. Read only. Permission `playbooks.run`.

- `playbooks_answerBuddyAsk`: Say yes or not now to being a new hire’s onboarding buddy. Write. Permission `playbooks.answerBuddyAsk`.

- `playbooks_answerBuddyFollowUp`: Answer whether you met your buddy or new hire, and whether it helped. Write. Permission `playbooks.answerBuddyFollowUp`.

- `playbooks_answerCheckIn`: Answer your onboarding program’s help check-in: all good, or ask HR for help. Write. Permission `playbooks.answerCheckIn`.

- `playbooks_answerFirstDaysCheckIn`: Answer your new-hire check-in. Write. Permission `playbooks.answerFirstDaysCheckIn`.

- `playbooks_answerForm`: Answer a playbook’s Tell us about you form; the answers fill in your profile. Write. Permission `playbooks.answerForm`.

- `playbooks_approve`: Approve these exact playbook messages for sending. Write. Permission `playbooks.approve`.

- `playbooks_askBuddy`: Ask this coworker to be your onboarding buddy. Write. Permission `playbooks.askBuddy`.

- `playbooks_assignBuddy`: Assign an onboarding buddy to a new hire. Write. Permission `playbooks.assignBuddy`.

- `playbooks_completeTodo`: Check off (or reopen) one of your own playbook to-dos. Write. Permission `playbooks.completeTodo`.

- `playbooks_draftPlan`: Have Mello draft the 30/60/90 plan for a new hire you manage (not yet shared). Write. Permission `playbooks.draftPlan`.

- `playbooks_enroll`: Put this person on a playbook. Write. Permission `playbooks.enroll`.

- `playbooks_nudge`: Send someone one Slack nudge about a hire’s overdue playbook to-dos, at most once a day. Write. Permission `playbooks.nudge`.

- `playbooks_previewEnrollment`: Preview the onboarding steps for a new hire. Write. Permission `playbooks.previewEnrollment`.

- `playbooks_remove`: Remove a new hire from onboarding. Write. Permission `playbooks.remove`.

- `playbooks_respondBuddy`: Accept or decline being an onboarding buddy. Write. Permission `playbooks.respondBuddy`.

- `playbooks_retry`: Retry a failed onboarding step. Write. Permission `playbooks.retry`.

- `playbooks_savePlan`: Write the goals of the 30/60/90 plan for a new hire you manage. Write. Permission `playbooks.savePlan`.

- `playbooks_saveProgram`: Save a playbook: its day 0, steps and messages. Write. Permission `playbooks.saveProgram`.

- `playbooks_setBuddyVolunteer`: Put someone on the buddy volunteer list, take them off it, or clear it. Write. Permission `playbooks.setBuddyVolunteer`.

- `playbooks_setPlanGoal`: Tick a goal on a shared 30/60/90 plan done, or not done. Write. Permission `playbooks.setPlanGoal`.

- `playbooks_sharePlan`: Share the 30/60/90 plan with the new hire you manage. Write. Permission `playbooks.sharePlan`.

- `playbooks_update`: Change a new hire's onboarding start date or time zone. Write. Permission `playbooks.update`.

- `playbooks_volunteerAsBuddy`: Say you are happy to be an onboarding buddy, or stop. Write. Permission `playbooks.volunteerAsBuddy`.

- [Playbooks API reference](https://shuffl.ai/docs/api-reference/playbooks)

<a id="tools-praise"></a>
## Praise

- `praise_composer`: Read who you can praise, the praise channels and company values. Read only. Permission `praise.composer`.

- `praise_feed`: Read the Praise feed. Read only. Permission `praise.feed`.

- `praise_insights`: Read Praise totals by value (groups of seven or more). Read only. Permission `praise.insights`.

- `praise_mine`: Read praise you gave and received. Read only. Permission `praise.mine`.

- `praise_ofPerson`: Read the public praise one person received. Read only. Permission `praise.ofPerson`.

- `praise_settings`: Read the Praise settings. Read only. Permission `praise.settings`.

- `praise_addChannel`: Read praise from this Slack channel from now on. Write. Permission `praise.addChannel`.

- `praise_removeChannel`: Stop reading praise from a Slack channel. Write. Permission `praise.removeChannel`.

- `praise_saveSettings`: Save the Praise settings and company values. Write. Permission `praise.saveSettings`.

- `praise_send`: Praise coworkers in a praise channel. Write. Permission `praise.send`.

- `praise_setDigest`: Choose whether you get the daily Praise digest. Write. Permission `praise.setDigest`.

- `praise_setHidden`: Hide or show a praise you received. Write. Permission `praise.setHidden`.

- `praise_setRecognition`: Choose whether praise for you is posted publicly or sent to you privately. Write. Permission `praise.setRecognition`.

- [Praise API reference](https://shuffl.ai/docs/api-reference/praise)

<a id="tools-profiles"></a>
## Profiles

- `profiles_get`: Read a person’s profile as this team sees it. Read only. Permission `profiles.get`.

- `profiles_whoKnows`: Find coworkers who know about a topic, place or skill from what they share on their profiles, with the words that matched. Read only. Permission `profiles.whoKnows`.

- `profiles_draft`: Draft the empty parts of your own profile with Mello; nothing is saved. Write. Permission `profiles.draft`.

- `profiles_employeeNumber`: Set a person’s employee number to an unused number. Write. Permission `profiles.employeeNumber`.

- `profiles_save`: Save your own profile: pronouns, location, phone, bio, interests, links and what you are working on. Write. Permission `profiles.save`.

- `profiles_settings`: Choose who sees the optional parts of your own profile. Write. Permission `profiles.settings`.

- `profiles_cover_delete`: Remove your profile cover picture. Write, destructive. Permission `profiles.cover.delete`.

- `profiles_photo_delete`: Remove your profile photo. Write, destructive. Permission `profiles.photo.delete`.

- `profiles_positions_delete`: Remove a past position from your profile. Write, destructive. Permission `profiles.positions.delete`.

- `profiles_positions_save`: Add or change a past position on your profile. Write. Permission `profiles.positions.save`.

- [Profiles API reference](https://shuffl.ai/docs/api-reference/profiles)

<a id="tools-pulse"></a>
## Pulse

- `pulse_actions`: List Pulse actions: what is being done about each result, its owner, due date and before and after. Read only. Permission `pulse.actions`.

- `pulse_asked`: List the Pulse questions asked so far. Read only. Permission `pulse.asked`.

- `pulse_groupTrends`: Read each group's Pulse results over time, period by period, with the change since the start (published group totals only). Read only. Permission `pulse.groupTrends`.

- `pulse_insights`: Read Pulse totals and trends (groups of seven or more). Read only. Permission `pulse.insights`.

- `pulse_latestRead`: Read what stands out in a closed Pulse question’s result. Read only. Permission `pulse.latestRead`.

- `pulse_mine`: Read your own Pulse streak, how many took part, and what changed because of it. Read only. Permission `pulse.mine`.

- `pulse_program`: Read the Pulse settings. Read only. Permission `pulse.program`.

- `pulse_proposals`: List the Pulse questions Mello suggested that wait for approval. Read only. Permission `pulse.proposals`.

- `pulse_questionDetail`: Read one closed Pulse question: its answer spread, every time it was asked, and results by group (groups of seven or more). Read only. Permission `pulse.questionDetail`.

- `pulse_questions`: List the Pulse question library. Read only. Permission `pulse.questions`.

- `pulse_today`: Read today’s Pulse question. Read only. Permission `pulse.today`.

- `pulse_addQuestion`: Add a Pulse question to the library. Write. Permission `pulse.addQuestion`.

- `pulse_addTemplate`: Add a Pulse question set from a template. Write. Permission `pulse.addTemplate`.

- `pulse_answer`: Answer today’s Pulse question as yourself. Write. Permission `pulse.answer`.

- `pulse_createAction`: Plan an action about a closed Pulse question, with an owner and a due date. Write. Permission `pulse.createAction`.

- `pulse_decideProposal`: Approve a suggested Pulse question so it is asked next, or dismiss it. Write. Permission `pulse.decideProposal`.

- `pulse_editProposal`: Reword a suggested Pulse question before approving it. Write. Permission `pulse.editProposal`.

- `pulse_proposeQuestions`: Save drafted Pulse questions as suggestions for HR to approve (never asked until approved). Write. Permission `pulse.proposeQuestions`.

- `pulse_requestProposals`: Ask Mello to suggest Pulse questions from recent results, optionally about a topic. Write. Permission `pulse.requestProposals`.

- `pulse_saveProgram`: Save Pulse settings; enabling Pulse schedules questions to everyone. Write. Permission `pulse.saveProgram`.

- `pulse_setQuestionGroup`: Aim a Pulse question at one of the workspace’s groups, or at everyone. Write. Permission `pulse.setQuestionGroup`.

- `pulse_setQuestionStatus`: Retire or restore a Pulse question. Write. Permission `pulse.setQuestionStatus`.

- `pulse_skip`: Skip today’s Pulse question. Write. Permission `pulse.skip`.

- `pulse_updateAction`: Change a Pulse action’s wording, owner, due date or status. Write. Permission `pulse.updateAction`.

- [Pulse API reference](https://shuffl.ai/docs/api-reference/pulse)

<a id="tools-reminders"></a>
## Reminders

- `reminders_mine`: Read your own Praise and Pulse reminder choices. Read only. Permission `reminders.mine`.

- `reminders_settings`: Read whether Praise and Pulse reminders are on, and their timing. Read only. Permission `reminders.settings`.

- `reminders_saveMine`: Change or turn off your own Praise or Pulse reminders. Write. Permission `reminders.saveMine`.

- `reminders_saveSetting`: Turn a Praise or Pulse reminder on or off, or change its timing. Write. Permission `reminders.saveSetting`.

- [Reminders API reference](https://shuffl.ai/docs/api-reference/reminders)

<a id="tools-reports"></a>
## Reports and insights

- `reports_answerFeedback`: Read feedback on Mello's answers. Read only. Permission `reports.answerFeedback`.

- `reports_celebrations`: Celebrations sent, people celebrated, birthdays and anniversaries, shared with the team, team cards and notes, share answers and missed messages over 30, 90 or 180 days against the period before, with a weekly series. Read only. Permission `reports.celebrations`.

- `reports_connections`: Read Connections insights. Read only. Permission `reports.connections`.

- `reports_knowledge`: Read Knowledge activity. Read only. Permission `reports.knowledge`.

- `reports_knowledgeSource`: Read activity for one Knowledge source. Read only. Permission `reports.knowledgeSource`.

- `reports_melloTrial`: What Mello handled during the trial, from day 25 of a trial until it ends. Read only. Permission `reports.melloTrial`.

- `reports_melloValue`: What Mello handled this week, this month and all time, with time saved once the team has set its minutes per question. Read only. Permission `reports.melloValue`.

- `reports_mentorship`: Mentorship over 30, 90 or 180 days against the period before: pairs started, ended early and completed, check-ins answered and met, pairs meeting and mentees waiting now; `programId` narrows it. Never goals. Read only. Permission `reports.mentorship`.

- `reports_needsYou`: Read HR request and Knowledge draft insights. Read only. Permission `reports.needsYou`.

- `reports_overview`: Read the workspace overview figures. Read only. Permission `reports.overview`.

- `reports_people`: Read People insights: headcount, teams and growth. Read only. Permission `reports.people`.

- `reports_playbooks`: Read Onboarding insights. Read only. Permission `reports.playbooks`.

- [Reports and insights API reference](https://shuffl.ai/docs/api-reference/reports)

<a id="tools-actions"></a>
## Requests Mello filed

- `actions_mine`: List the requests Mello filed for you and where each stands. Read only. Permission `actions.mine`.

- [Requests Mello filed API reference](https://shuffl.ai/docs/api-reference/actions)

<a id="tools-support"></a>
## Shuffl support

- `support_get`: Read one Shuffl support conversation. Read only. Permission `support.get`.

- `support_list`: List the workspace's support conversations with Shuffl. Read only. Permission `support.list`.

- `support_assign`: Assign a Shuffl support conversation. Write. Permission `support.assign`.

- `support_close`: Close a Shuffl support conversation. Write, destructive. Permission `support.close`.

- `support_create`: Start a support conversation with Shuffl. Write. Permission `support.create`.

- `support_reply`: Reply in a Shuffl support conversation. Write. Permission `support.reply`.

- [Shuffl support API reference](https://shuffl.ai/docs/api-reference/support)

<a id="tools-channels"></a>
## Slack channels

- `channels_list`: List available Slack channels. Read only. Permission `channels.list`.

- [Slack channels API reference](https://shuffl.ai/docs/api-reference/channels)

<a id="tools-time-off"></a>
## Time off

- `timeOff_balances`: Read your own time-off balances from the connected HR system. Read only. Permission `timeOff.balances`.

- [Time off API reference](https://shuffl.ai/docs/api-reference/time-off)

<a id="tools-webhooks"></a>
## Webhooks

- `webhooks_catalog`: List the webhook event types and which ones this key can subscribe to. Read only. Permission `webhooks.catalog`.

- `webhooks_get`: Read one webhook endpoint. Read only. Permission `webhooks.get`.

- `webhooks_list`: List webhook endpoints, their status and delivery success over 24 hours. Read only. Permission `webhooks.list`.

- `webhooks_create`: Add a webhook endpoint that receives the chosen events, and get its signing secret. Write. Permission `webhooks.create`.

- `webhooks_delete`: Delete a webhook endpoint and its delivery log. Write, destructive. Permission `webhooks.delete`.

- `webhooks_rotateSecret`: Roll a webhook endpoint’s signing secret, keeping the old one valid for a while. Write. Permission `webhooks.rotateSecret`.

- `webhooks_sendTest`: Send a webhook.test event to an endpoint now. Write. Permission `webhooks.sendTest`.

- `webhooks_update`: Change a webhook endpoint’s URL, description or events, or turn it on or off. Write. Permission `webhooks.update`.

- `webhooks_deliveries_get`: Read one webhook delivery: the request body and every attempt’s answer. Read only. Permission `webhooks.deliveries.get`.

- `webhooks_deliveries_list`: List an endpoint’s webhook deliveries, newest first. Read only. Permission `webhooks.deliveries.list`.

- `webhooks_deliveries_replay`: Resend one webhook delivery with the same event id. Write. Permission `webhooks.deliveries.replay`.

- `webhooks_deliveries_replayFailed`: Resend every failed webhook delivery of an endpoint since a time. Write. Permission `webhooks.deliveries.replayFailed`.

- [Webhooks API reference](https://shuffl.ai/docs/api-reference/webhooks)

<a id="tools-capabilities"></a>
## What Mello can do

- `capabilities_requests`: How many people asked HR to connect a system, per capability. Read only. Permission `capabilities.requests`.

- `capabilities_sheet`: What Mello can answer and do for you here, and what connecting a system would add. Read only. Permission `capabilities.sheet`.

- `capabilities_unlocks`: What people can ask and do once an HR system or document tool is connected. Read only. Permission `capabilities.unlocks`.

- `capabilities_dismissRequests`: Clear the asks to connect a system for one capability. Write. Permission `capabilities.dismissRequests`.

- `capabilities_requestConnection`: Ask HR to connect the system this needs. Write. Permission `capabilities.requestConnection`.

- [What Mello can do API reference](https://shuffl.ai/docs/api-reference/capabilities)

<a id="tools-teams"></a>
## Workspace

- `teams_connectionPermissions`: List connections whose permissions are behind what Shuffl asks for. Read only. Permission `teams.connectionPermissions`.

- `teams_setup`: Read the workspace's setup checklist. Read only. Permission `teams.setup`.

- `teams_slackChannels`: List community channels in the connected Slack and what each would become. Read only. Permission `teams.slackChannels`.

- `teams_slackConnection`: Read whether the workspace's Slack is connected, and why not. Read only. Permission `teams.slackConnection`.

- `teams_slackJoinAccess`: Read whether Slack members can join Shuffl on their own. Read only. Permission `teams.slackJoinAccess`.

- `teams_slackProfileLink`: Read the Shuffl profile link setting for Slack profiles. Read only. Permission `teams.slackProfileLink`.

- `teams_discardPairHistory`: Remove this staged past-intros report. Write. Permission `teams.discardPairHistory`.

- `teams_initialize`: Finish setting up a new workspace. Write. Permission `teams.initialize`.

- `teams_moveSlackChannels`: Set up each channel in Shuffl: paused intros, praise and celebrations. Write. Permission `teams.moveSlackChannels`.

- `teams_rename`: Rename the workspace. Write. Permission `teams.rename`.

- `teams_resendSlackWelcome`: Send the Slack install welcome to your own Slack DM again. Write. Permission `teams.resendSlackWelcome`.

- `teams_saveAgentSetup`: Choose the built-in assistant or an external agent for the workspace. Write. Permission `teams.saveAgentSetup`.

- `teams_saveSlackJoinAccess`: Choose whether Slack members can join Shuffl on their own. Write. Permission `teams.saveSlackJoinAccess`.

- `teams_saveSlackProfileLink`: Turn the Shuffl profile link on Slack profiles on or off. Write. Permission `teams.saveSlackProfileLink`.

- `teams_status`: Pause or resume the whole workspace. Write. Permission `teams.status`.

- `teams_syncSlackProfileLinks`: Write the Shuffl profile link to every Slack profile again. Write. Permission `teams.syncSlackProfileLinks`.

- `teams_uploadPairHistory`: Stage this past-intros report for the switch; nothing changes until it is applied. Write. Permission `teams.uploadPairHistory`.

- [Workspace API reference](https://shuffl.ai/docs/api-reference/teams)

<a id="tools-team"></a>
## Workspace launch

- `team_launchPost`: Read the launch announcement for the workspace. Read only. Permission `team.launchPost`.

- `team_answerMinutes`: Set the team estimate of minutes per HR question, used for time saved. Write. Permission `team.answerMinutes`.

- `team_dismissLaunchPost`: Dismiss the Tell your team what they can ask post on Today for everyone. Write. Permission `team.dismissLaunchPost`.

- [Workspace launch API reference](https://shuffl.ai/docs/api-reference/team)

## Related guides

- [Connect an MCP client](https://shuffl.ai/docs/mcp)

- [API endpoint permissions](https://shuffl.ai/docs/api-permissions)

- [REST API reference](https://shuffl.ai/docs/api-reference)

Agent documentation index: https://shuffl.ai/llms.txt

