HelpWell

Approve a pending proposal, optionally with edited guidance text, so it joins the product's playbook the AI agent follows. Admins only.

approve_training_proposal

Take a help article out of the help center and away from the agent, keeping it and its history. update_article with status "published" brings it back. Articles are not deleted from here.

archive_article

Give a conversation to a teammate (their user id), hand it back to the AI agent ("ai"), or leave it with the team unassigned (null).

assign_conversation

Start building the product's knowledge base from its connected GitHub repositories, on the workspace's model and within the build budget. Drafts reach Code updates for review as they are written.

build_knowledge_base

Stops a scheduled or sending newsletter; email not yet handed to the provider is not sent.

cancel_newsletter

Change one help center, widget or changelog setting of a hosted product by its dotted path (from get_help_center_settings), e.g. "widget.appearance.accent" or "helpCenter.search", or product.supportEmail, product.timezone or product.locale. The agent is set up in Agent training, and webhooks and secrets in the app.

update_help_center_setting

Change a teammate's role. A viewer's open conversations go back to the queue. The workspace always keeps an owner.

change_teammate_role

Set the app's address and the pages to photograph for articles (each a name and a path starting with /). The list given replaces the pages there. A sign-in cookie for the app is pasted in the app, not here.

update_app_screenshots

Who writes the code-driven article updates (HelpWell on the workspace's model, or the customer's coding agent), whether they publish without review, whether the knowledge base builds itself, and the limits per check and for the build.

update_code_update_settings

Check a custom help center domain now: its DNS records, certificate and whether it is live.

check_help_center_domain

The send pre-flight: sender, audience counts after consent, suppressions and the frequency cap, email setup readiness, and every content and link check. canSend says whether it can be scheduled.

check_newsletter

Re-read an email domain's status from Resend and look up its DNS records again, without asking Resend to verify.

check_mail_domain

How many addresses an audience (segments, tags, filters, exclusions) would reach now, after consent and suppressions: eligible, in scope, not subscribed, suppressed and at the frequency cap. Nothing is saved.

count_newsletter_audience

How many contacts match a search, segment, product or email status (all contacts when none is given).

count_contacts

How many contacts share an email address with another contact.

count_duplicate_contacts

Write a changelog entry. It is a draft unless status is "published", which shows it on the public changelog and in the widget.

create_changelog_entry

Write a new help article in a hosted product, saved as the editor saves it and indexed for search and the agent at once. It is a draft unless status is "published". Name an existing collection by id or title, or a new one to start it. Pass gapId when the article answers an unanswered question: the question is then marked drafted.

create_article

Start a new collection in the help center, with its title and optional description and icon, before any article is filed in it. Its id (the first part of its articles' slugs) is made from the title.

create_collection

Saves a new draft journey from a full definition. It stays a draft until publish_journey. A recipe or generate_journey is usually a simpler start.

create_journey

Copies a recipe into a new draft journey. Its email steps start empty and require ready email content before the journey can be published.

create_journey_from_recipe

Saves a new newsletter draft from plain fields (subject, title, introduction, sections, button). Nothing is sent. This action uses the supplied content without AI generation or template selection.

create_newsletter

Saves a new chat message, pop-up or banner as a draft. Visitors see nothing until publish_proactive_message. write_proactive_message_copy can draft the words.

create_proactive_message

Add a product to the workspace. "hosted" (the default) gives it a HelpWell-hosted help center, widget and knowledge base, set up before this returns; "connected" is for a self-hosted install that connects to HelpWell. Returns the new product id and its setup status.

create_product

Save a reply the team can insert in the composer. Use {{first_name}}, {{agent_name}} and {{product}}, with a fallback after a bar: {{first_name | there}}.

create_saved_reply

Saves a segment: contacts matching rules on contact fields. Newsletters, journeys and messages can then target it. This action saves the rules without sending messages.

create_segment

Create a contact field ahead of its first value, or lock a guessed one to a type, so segments, journeys and personalization treat it right. Keys starting lf_ or icp_ are HelpWell's own.

define_field

Delete a changelog entry for good. To take one off the public changelog but keep it, set its status to "archived" with update_changelog_entry instead.

delete_changelog_entry

Deletes a journey: everyone in it exits and what it queued is cancelled. Its history stays, and restore_journey brings it back paused.

delete_journey

Archives a message: it stops at once and what journeys queued is cancelled. Its stats are kept, but it cannot be brought back.

delete_proactive_message

Delete a saved reply for everyone who could use it. It cannot be restored.

delete_saved_reply

Deletes a saved template. Emails already started from it are not affected. It cannot be undone.

delete_email_template

Delete one email from the External tab without blocking its sender.

delete_external_mail

Discard one proposed article update. Nothing in the knowledge base changes.

discard_code_update

Drops the unpublished draft of a journey; the live version stays as it is.

discard_journey_draft

Disconnect the workspace's Resend account. Support and marketing email stop until the person connects a key again in Settings → Email. Domains and settings are kept.

disconnect_resend

Hide the Get started checklist for the whole workspace, or show it again with dismissed false.

dismiss_get_started

Leave a held emailed reply out of the conversation for good. The note stays, marked dismissed; it cannot be accepted afterwards.

dismiss_held_reply

Dismiss a pending proposal, with an optional reason kept for the team. Admins only.

dismiss_training_proposal

Take an unanswered question off the list without writing an article, when it needs none. reopen_gap brings it back.

dismiss_gap

Turn a conversation's latest answer into an article proposal in Training, for review with approve_training_proposal. Nothing is published.

draft_article_from_conversation