Hearsay Docs

What an AI app can do

Every action a connected AI app can take in Hearsay, which permission and role each needs, and what it can't do.

A connected app works in one workspace, as you. It can only do what you allowed when you connected, and what your role in that workspace allows. See Use Hearsay from Claude or ChatGPT.

What it can do

Action What it does Needs
List surveys (list_surveys) Lists the workspace's surveys, newest first, with their status and response counts Any role
Get survey (get_survey) Shows one survey's questions and what still stops it being published Any role
Create survey (create_survey) Makes a new draft from a title and questions, or from a template. It isn't public until it's published Create and edit surveys, editor or above
Edit survey (edit_survey) Adds, rewords, reorders or removes questions, pages and end screens. A live survey changes for customers only when it's published again Create and edit surveys, editor or above
Publish survey (publish_survey) Opens the survey to customers and gives its share link. Also reopens a closed survey Publish surveys, editor or above
Close survey (close_survey) Stops new responses. Answers you have stay Publish surveys, editor or above
Delete survey (delete_survey) Moves the survey to Trash, closing it if it's live Create and edit surveys, editor or above (see below)
Get share links (get_share_kit) The public link, a link per channel, QR codes, the table card and embed code Any role
Get results (get_results) Response counts, completion, NPS and each question's chart, with filters Read results
Search answers (search_responses) Quotes from open-text answers, filtered by score, channel or date, up to 50 at a time Read results
List templates (list_templates) Hearsay's templates by category, to start a survey from one Any role
Share results (create_report) Makes a read-only report link, with an optional password and expiry date Read results, editor or above, Pro and above
Search Hearsay help (search_docs) Searches these docs Every connection
Read a Hearsay help page (get_doc) Reads one page of these docs Every connection

Publishing, closing, deleting and sharing results change things, so the app asks you before it runs them, and runs them only when you ask.

Filters follow your plan, the same as in Hearsay: on Free, the app can filter results by date and channel only. See Filter responses.

Deleting goes to Trash

When an AI app deletes a survey, it isn't deleted straight away. It's closed and moved to Trash at the bottom of the Surveys page for 30 days, then it and its responses are deleted for good. Until then you can Restore it (it comes back closed) or Delete now. See Close, reopen and delete surveys.

Editors can delete, and restore, only the surveys they created. Owners and admins can delete any survey.

A survey in Trash doesn't show up in the app's lists, and can't be edited or published until you restore it in Hearsay.

What it can't do

  • See or change billing, or your plan.
  • Invite, remove or change team members.
  • Reach any workspace other than the one you connected.
  • Change brands, coupons, webhooks or workspace settings.
  • See respondents' contact details, unless an owner or admin turns that on. See AI assistants and your data.

Viewers

A viewer can connect, but only to read: their connection never gets Create and edit surveys or Publish surveys. The app can list surveys, show results and quotes, and search the docs. If it tries to share results, Hearsay refuses with This action needs the editor role or higher.

Hearsay checks your role on every request, so a lower role takes effect straight away. If a viewer becomes an editor, they need to connect again to get the permissions to change surveys.

Limits

AI apps you connect follow your plan's limits, the same as Hearsay. When a limit is reached, the app says so and links to the plans.

To keep things fair, each connection can make 60 calls a minute (20 of them changes), and each workspace 5,000 calls a day. When a limit is hit, the app is told when it can try again:

  • Too many requests: Hearsay allows 60 calls a minute per connection. Try again in N seconds.
  • This workspace has used today's 5000 AI app calls. Try again tomorrow (UTC).

When something is refused

Message What to do
This connection wasn't given the … permission. Reconnect Hearsay… Connect again and tick that permission.
This action needs the editor role or higher. Ask an owner or admin to change your role. See Roles and what each can do.
That survey is in Trash. Restore it in Hearsay first. Restore it from Trash on the Surveys page.
This connection was disconnected in Hearsay. Connect again to continue. Someone disconnected it under Connected AI apps. Connect again.
This connection is for a different workspace. Connect again and pick the other workspace.
Your access to this workspace is paused until its owner upgrades the plan. See Paused team members.
You are not a member of this workspace. You left or were removed. Ask an owner or admin to invite you again.

Type to search every page.