Set up Hey Quad with an AI app
Owners and admins can connect ChatGPT, Claude or another AI app to the Org Admin connector to help set Hey Quad up. Turn it on, connect, what it can change, what waits for approval, and what only a person can do in Hey Quad.
The Org Admin connector lets an AI app help set Hey Quad up for your organization: how the CRM is organized, call flows, the AI receptionist, routing and the phone system. It's separate from the Business connector that everyone uses for everyday work, and it's off until an admin turns it on.
The app works as the person who connects it, with their permissions. Most changes are drafts or can be undone, and anything that goes live for callers or spends money waits for a person to approve it in Hey Quad.
Turn it on
The Org Admin connector has its own switch, separate from Allow AI apps.
- Make sure Allow AI apps is on under Settings → Inbox & email. See Use ChatGPT, Claude or another AI app with Hey Quad.
- On the same page, find AI apps may change settings.
- Turn on Allow AI apps to change settings and confirm.
Changing this switch needs both the "Manage general settings" and "Turn on AI apps" permissions, which owners have. Organizations that handle health information (PHI) can't turn it on.
Turning it off stops every app connected this way on its next request. Business connections keep working.
Connect your app
- Copy the address shown under Address to add in the AI app:
https://mcp.heyquad.com/mcp/admin. - In your AI app, add a custom connector or MCP server with that address. Use a separate connector from the Business one.
- Sign in to Hey Quad, pick the organization, choose the areas the app may use, such as CRM setup, Call handling, Phone system or Team & billing, and click Allow.
Anyone who can sign in can connect, but the app can only do what that person's role allows. A member without settings permissions gets few or no tools.
How changes happen
- Reads: the app looks at how things are set up today. Nothing changes. This includes a dry run of a call flow: the app plays a pretend caller (pressing keys, calling after hours, nobody picking up) and tells you each step the call would take, what the caller would hear and where the call ends. No call is placed, no phone rings and nothing is saved.
- Drafts: call flows, the AI receptionist and integrations are edited as drafts. Callers keep getting the published version until someone publishes the draft.
- Changes, can be undone: some live settings, such as business hours, holidays, queue members, extension settings and number routing, change at once. The app gets an undo and can put things back if you ask. Pointing a number at an extension also sends its texts there when nobody had chosen where they go, as in Hey Quad; its undo puts the texts back too.
- Needs approval: publishing a flow, a receptionist or an integration, buying, releasing or porting a number, and importing contacts or companies from a spreadsheet (CSV) go to the Approvals list. An import shows how many rows are new, which match people already in your CRM, and which rows will be skipped and why. Once it has run, the app can ask to take the import back, which deletes only the records it created. A person who holds the same permissions approves them in Hey Quad, with a two-factor check where Hey Quad asks for one. The approval shows what will change. See Approve what an AI app asks to do.
Every action the app takes is recorded with the person's name and the app's name.
What stays in Hey Quad
An AI app can never do these, on either connector. A person does them in Hey Quad:
- delete the organization, transfer ownership, or export all of its data;
- accept agreements, or sign or change a contract;
- turn AI apps on;
- change privacy or health-information (HIPAA) settings, or how long recordings are kept;
- change an emergency (911) address;
- see or change SIP passwords, the port-out PIN, or caller ID attestation;
- change sign-in security or the two-factor policy;
- remove members;
- add or change a payment method.
Tools
These are the tools an app connected to the Org Admin connector can use, by the area you allow when you connect. The list comes straight from Hey Quad, so it's always current. An app only sees the ones your permissions allow.
CRM setup
How the CRM is set up. An app gets these tools when you allow CRM setup.
| Tool | What it does | Kind | Permissions it needs | Command |
|---|---|---|---|---|
| crm_setup | The CRM's whole setup, with ids: types, stages, fields (enabled or not), lifecycle and tags. | Reads | Set up the CRM | hq crm-setup schema |
| work_type | Create or change a work type (deals, tickets, jobs…); answers `undo`. Takes: type (text), label (text), pluralLabel (text), trackValue (yes or no), enabled (yes or no), showInSidebar (yes or no), defaultView (text), alertOnNew (yes or no), autoCreateContact (yes or no) | Changes, can be undone | Set up the CRM | hq crm-setup work-type |
| work_stages | Set a work type's stages, in order; answers `undo`. Takes: type (text, required), stages (list, required) | Changes, can be undone | Set up the CRM | hq crm-setup stages |
| record_type | Create or change a contact or company type (Vendor, Partner…); answers `undo`. Takes: type (text), label (text), appliesTo (text) | Changes, can be undone | Set up the CRM | hq crm-setup record-type |
| field | Add or change a custom field (text, dropdown, number, yes/no…); answers `undo`. Takes: object (text, required), key (text), label (text), fieldType (text), options (list), enabled (yes or no) | Changes, can be undone | Set up the CRM | hq crm-setup field |
| field_order | Set the order of an object's fields; answers `undo`. Takes: object (text, required), keys (list, required) | Changes, can be undone | Set up the CRM | hq crm-setup field-order |
| lifecycle_stage | Add or change a contact lifecycle stage (Lead, Customer…); answers `undo`. Takes: stage (text), label (text), color (text), isDefault (yes or no) | Changes, can be undone | Set up the CRM | hq crm-setup lifecycle-stage |
| tag | Rename a tag, or merge it into another, on every record of a kind; answers `undo`. Takes: object (text, required), from (text, required), to (text, required) | Changes, can be undone | Set up the CRM | hq crm-setup tag |
| crm_delete | Propose deleting a work type, contact/company type, field or lifecycle stage. Takes: what (text, required), key (text, required), object (text), moveTo (text), summary (text) | Needs approval | Set up the CRM | hq crm-setup delete |
| import_contacts | Propose importing contacts or companies from a CSV (a person approves it in HeyQuad). Takes: csv (text), attachmentId (text), type (text), map (list), onMatch (text), tags (list), recordType (text), summary (text) | Needs approval | Set up the CRM, Edit contacts | hq crm-setup import-contacts |
| undo_import | Propose deleting the records an import created (a person approves it in HeyQuad). Takes: ids (list, required), importedAt (text, required), summary (text) | Needs approval | Set up the CRM, Edit contacts | hq crm-setup undo-import |
Call handling
Call flows, the AI receptionist, routing and audio. An app gets these tools when you allow Call flows, AI receptionist, Routing, Audio and voicemail.
| Tool | What it does | Kind | Permissions it needs | Command |
|---|---|---|---|---|
| flows | List the org's call flows: status, the numbers each answers, the last publish. Takes: includeArchived (yes or no), kind (text) | Reads | See call flows | hq flows list |
| flow | Read one call flow: the live definition, the draft, what uses it, recent publishes. Takes: flow (text, required) | Reads | See call flows | hq flows get |
| flow_catalog | The node types a flow can use: fields, required fields, options, events and docs. Takes: type (text) | Reads | See call flows | hq flows catalog |
| validate_flow | Check a flow's draft with the publish validator (errors block publishing). Takes: flow (text, required) | Reads | See call flows | hq flows validate |
| publish_flow_preview | What publishing the draft would change: nodes added, removed and changed, numbers affected. Takes: flow (text, required) | Reads | See call flows | hq flows preview |
| flow_dry_run | Walk a flow with a pretend caller: the path, what they hear, where the call ends up. Takes: flow (text, required), definition (text), caller (text), called (text), at (text), input (list), outcome (list), var (list), result (list), maxTurns (number) | Reads | See call flows | hq flows dry-run |
| create_flow | Create a call flow: blank, from a template, or from a definition (saved as its draft). Takes: name (text, required), template (text), definition (JSON object) | Draft | See call flows, Edit call flows | hq flows create |
| duplicate_flow | Copy a call flow (its live version) into a new flow that nothing routes to. Takes: flow (text, required), name (text) | Draft | See call flows, Edit call flows | hq flows duplicate |
| edit_flow | Edit a flow's draft: replace the whole definition and/or apply targeted node edits. Takes: flow (text, required), definition (JSON object), ops (list of JSON objects) | Draft | See call flows, Edit call flows | hq flows edit |
| discard_flow_draft | Throw away a flow's unpublished draft. Takes: flow (text, required) | Draft | See call flows, Edit call flows | hq flows discard |
| rename_flow | Rename a flow (in its draft; the name goes live when the flow is published). Takes: flow (text, required), name (text, required) | Draft | See call flows, Edit call flows | hq flows rename |
| publish_flow | Publish a flow's draft so callers hear it (an AI app's request goes to the Approvals list). Takes: flow (text, required), message (text) | Needs approval | See call flows, Publish call flows | hq flows publish |
| revert_flow | Make an earlier published version live again (an AI app's request goes to the Approvals list). Takes: flow (text, required), toVersion (number, required), message (text) | Needs approval | See call flows, Publish call flows | hq flows rollback |
| set_default_flow | Make a flow the org's default flow (an AI app's request goes to the Approvals list). Takes: flow (text, required) | Needs approval | See call flows, Publish call flows | hq flows set-default |
| archive_flow | Archive a flow nothing routes to (an AI app's request goes to the Approvals list). Takes: flow (text, required) | Needs approval | See call flows, Edit call flows | hq flows archive |
| receptionists | List the AI receptionists Takes: includeArchived (yes or no) | Reads | See the receptionist | hq receptionists list |
| receptionist | One AI receptionist, described part by part Takes: id (text, required), live (yes or no) | Reads | See the receptionist | hq receptionists get |
| receptionist_kb | Knowledge bases and their documents, or search them Takes: receptionist (text), search (text) | Reads | See the receptionist | hq receptionists kb |
| receptionist_usage | How a receptionist's calls went Takes: id (text, required), days (number) | Reads | See the receptionist | hq receptionists usage |
| kb_gaps | Questions callers asked that the knowledge didn't answer Takes: id (text, required), days (number) | Reads | See the receptionist | hq receptionists kb-gaps |
| set_greeting | Change what the receptionist says first Takes: id (text, required), text (text, required), callerCanInterrupt (yes or no) | Draft | See the receptionist, Edit the receptionist | hq receptionists set-greeting |
| set_persona | Change who the receptionist is and how it behaves Takes: id (text, required), name (text), businessName (text), role (text), tone (list), style (text), instructions (text) | Draft | See the receptionist, Edit the receptionist | hq receptionists set-persona |
| set_hours_behavior | Choose its business hours and what it does after hours Takes: id (text, required), schedules (list), checkHours (yes or no), afterHours (text), afterHoursNote (text) | Draft | See the receptionist, Edit the receptionist | hq receptionists set-hours |
| set_transfer_targets | Choose where the receptionist may send callers Takes: id (text, required), extension (text), numbers (list), queues (list), assistants (list), flows (list) | Draft | See the receptionist, Edit the receptionist | hq receptionists set-transfers |
| set_transfer_hours | Choose whether a transfer destination takes callers after hours Takes: id (text, required), destination (text, required), afterHours (text), schedule (text) | Draft | See the receptionist, Edit the receptionist | hq receptionists set-transfer-hours |
| enable_tool | Turn on one of the receptionist's tools, with its settings Takes: id (text, required), key (text, required), requireVerification (yes or no), fillerPhrase (text), messageMode (text), notifyTeam (yes or no), emailTo (list), textTo (list), alsoNotifyOwners (yes or no), voicemailBox (text), voicemailGreeting (text), extension (text), numbers (list), defaultNumber (text), assistants (list), flows (list), queues (list), ticketType (text), ticketQueue (text), extensions (list), textStaff (yes or no), onCall (list), pageOnUrgent (yes or no), callerNumberOnly (yes or no), anyAddress (yes or no), lookUpAnyNumber (yes or no), calendars (list), services (list), slotsOffered (number), confirmByText (yes or no), confirmByEmail (yes or no), allowedTags (list), ownSystem (JSON object) | Draft | See the receptionist, Edit the receptionist | hq receptionists enable-tool |
| configure_tool | Change a tool's settings without turning it on or off Takes: id (text, required), key (text, required), requireVerification (yes or no), fillerPhrase (text), messageMode (text), notifyTeam (yes or no), emailTo (list), textTo (list), alsoNotifyOwners (yes or no), voicemailBox (text), voicemailGreeting (text), extension (text), numbers (list), defaultNumber (text), assistants (list), flows (list), queues (list), ticketType (text), ticketQueue (text), extensions (list), textStaff (yes or no), onCall (list), pageOnUrgent (yes or no), callerNumberOnly (yes or no), anyAddress (yes or no), lookUpAnyNumber (yes or no), calendars (list), services (list), slotsOffered (number), confirmByText (yes or no), confirmByEmail (yes or no), allowedTags (list), ownSystem (JSON object) | Draft | See the receptionist, Edit the receptionist | hq receptionists configure-tool |
| disable_tool | Turn off one of the receptionist's tools Takes: id (text, required), key (text, required) | Draft | See the receptionist, Edit the receptionist | hq receptionists disable-tool |
| set_integration_tool | Let the receptionist use one of your own systems (an integration operation) Takes: id (text, required), integration (text, required), operation (text, required), connection (text), pinVersion (number), toolName (text), description (text), enabled (yes or no), requireVerification (yes or no), callerInputs (list), fixedInputs (list), modelInputs (list), outcome (text), kind (text), requestKeyInputs (list), capabilityPhrase (text), guidance (text), readBack (yes or no) | Draft | See the receptionist, Edit the receptionist | hq receptionists set-integration-tool |
| remove_integration_tool | Take one of your own systems' tools away from the receptionist Takes: id (text, required), tool (text, required) | Draft | See the receptionist, Edit the receptionist | hq receptionists remove-integration-tool |
| set_caller_verification | Choose how callers prove who they are, and where they are looked up Takes: id (text, required), method (text), textFrom (text), authorizedOnly (yes or no), lookupIntegration (text), lookupOperation (text), lookupConnection (text), lookupVersion (number), lookupPhoneInput (text), lookupEmailInput (text), lookupOutputs (list), lookupFixedInputs (list), lookupOrder (text), removeLookup (yes or no) | Draft | See the receptionist, Edit the receptionist | hq receptionists set-verification |
| discard_receptionist_draft | Throw away the receptionist's unpublished changes Takes: id (text, required) | Draft | See the receptionist, Edit the receptionist | hq receptionists discard-draft |
| receptionist_test | Try the receptionist in text, with no call and no side effects Takes: id (text, required), messages (list, required), live (yes or no), afterHours (yes or no) | Draft | See the receptionist, Edit the receptionist | hq receptionists test |
| kb_add_document | Add a document to the receptionist's knowledge Takes: id (text, required), title (text), text (text), url (text), knowledgeBase (text) | Changes, can be undone | See the receptionist, Edit the receptionist | hq receptionists kb-add |
| kb_remove_document | Remove a document from a knowledge base Takes: id (text, required) | Changes, can be undone | See the receptionist, Edit the receptionist | hq receptionists kb-remove |
| kb_reindex | Read a knowledge document again Takes: id (text, required) | Changes, can be undone | See the receptionist, Edit the receptionist | hq receptionists kb-reindex |
| call_outcomes | The call outcomes calls are reported with | Reads | Any member | hq receptionists outcomes |
| create_call_outcome | Add one of your own call outcomes Takes: label (text, required), category (text, required), key (text), rank (number), color (text) | Changes, can be undone | Manage general settings | hq receptionists outcome-add |
| update_call_outcome | Change or restore one of your call outcomes Takes: id (text, required), label (text), category (text), rank (number), color (text), archived (yes or no) | Changes, can be undone | Manage general settings | hq receptionists outcome-edit |
| archive_call_outcome | Archive one of your call outcomes Takes: id (text, required) | Changes, can be undone | Manage general settings | hq receptionists outcome-archive |
| publish_receptionist | Put the receptionist's draft live Takes: id (text, required), message (text), summary (text) | Needs approval | See the receptionist, Put the receptionist live | hq receptionists publish |
| bind_number | Point a phone number at the receptionist Takes: id (text, required), number (text, required), summary (text) | Needs approval | See the receptionist, Edit the receptionist, Manage call routing | hq receptionists bind-number |
| hours | Business-hours schedules: weekly hours, holidays, and what uses each Takes: schedule (text) | Reads | Any member | hq hours list |
| set_hours | Change a schedule's weekly hours or timezone, live; returns undo Takes: schedule (text, required), rules (list of JSON objects), timezone (text) | Changes, can be undone | Manage general settings | hq hours set |
| holiday | Close a schedule for a date (or dates), give it special hours, or remove that; live, with undo Takes: schedule (text, required), date (text, required), through (text), label (text), windows (list of JSON objects), remove (yes or no) | Changes, can be undone | Manage general settings | hq hours holiday |
| create_schedule | Create a business-hours schedule Takes: name (text, required), timezone (text), rules (list of JSON objects), copyFrom (text) | Changes, can be undone | Manage general settings | hq hours create |
| rename_schedule | Rename a schedule; returns undo Takes: schedule (text, required), name (text, required) | Changes, can be undone | Manage general settings | hq hours rename |
| set_default_schedule | Make a schedule the organization's default, live; returns undo Takes: schedule (text, required) | Changes, can be undone | Manage general settings | hq hours set-default |
| delete_schedule | Ask to delete a schedule nothing uses (goes to Approvals) Takes: schedule (text, required), summary (text) | Needs approval | Manage general settings | hq hours delete |
| queues | Call queues: settings, members with live status, who is waiting now, and what uses each Takes: queue (text) | Reads | Any member | hq queues list |
| queue_settings | Change a queue's settings, live; returns undo Takes: queue (text, required), name (text), strategy (text), active (yes or no), ringSeconds (number), maxWaitSecs (number), thenGoTo (JSON object), holdMusic (text), announcePosition (yes or no), announceIntervalSecs (number), holdMessageText (text), holdMessage (text), defaultPriority (number), wrapUpSecs (number), slTargetSecs (number), slGoalPct (number), voicemailBox (text), recordAi (text), recordAgent (text) | Changes, can be undone | Manage call routing | hq queues set |
| queue_members | Add, remove or re-rank a queue's members, live; returns undo Takes: queue (text, required), add (list), remove (list), set (list of JSON objects) | Changes, can be undone | Manage call routing | hq queues set-members |
| create_queue | Create a call queue Takes: name (text, required), strategy (text), members (list) | Changes, can be undone | Manage call routing | hq queues create |
| delete_queue | Ask to delete a queue nothing uses (goes to Approvals) Takes: queue (text, required), summary (text) | Needs approval | Manage call routing | hq queues delete |
| voicemail_boxes | Voicemail boxes: greetings, settings and who hears each Takes: box (text) | Reads | Any member | hq voicemail-boxes list |
| voicemail_box_settings | Change a voicemail box's settings, live; returns undo Takes: box (text, required), name (text), description (text), hoursSchedule (text), voice (text), language (text), maxLengthSecs (number), finishOnKey (text), silenceTimeoutSecs (number), playBeep (yes or no), thanksText (text), adminsAreMembers (yes or no), aiTakeMessage (yes or no) | Changes, can be undone | Manage voicemail boxes | hq voicemail-boxes set |
| voicemail_box_members | Add or remove who hears a shared voicemail box, live; returns undo Takes: box (text, required), addPeople (list), removePeople (list), addQueues (list), removeQueues (list) | Changes, can be undone | Manage voicemail boxes | hq voicemail-boxes set-members |
| voicemail_greeting | Set a voicemail box's greeting from text or an audio file, live; returns undo Takes: box (text, required), slot (text), text (text), audio (text), off (yes or no), play (text) | Changes, can be undone | Manage voicemail boxes | hq voicemail-boxes set-greeting |
| audio | The audio library: prompts and hold music, their text, and where each is used Takes: asset (text), kind (text), q (text), limit (number), cursor (text) | Reads | Use prompts & music | hq audio list |
| create_prompt | Create a text-to-speech prompt in the audio library Takes: name (text, required), text (text, required), voice (text), language (text), description (text), tags (list) | Changes, can be undone | Use prompts & music, Manage prompts & music | hq audio create-prompt |
| render_prompt | Re-render a text-to-speech prompt with new text or voice, live; returns undo Takes: asset (text, required), text (text), voice (text), language (text) | Changes, can be undone | Use prompts & music, Manage prompts & music | hq audio render |
| use_audio_revision | Make an earlier revision of an audio file the one that plays, live; returns undo Takes: asset (text, required), rev (number, required) | Changes, can be undone | Use prompts & music, Manage prompts & music | hq audio use-revision |
| rename_audio | Rename an audio file or change its description and tags; returns undo Takes: asset (text, required), name (text), description (text), tags (list) | Changes, can be undone | Use prompts & music, Manage prompts & music | hq audio rename |
| delete_audio | Ask to delete an audio file nothing plays (goes to Approvals) Takes: asset (text, required), summary (text) | Needs approval | Use prompts & music, Manage prompts & music | hq audio delete |
Phone system
Numbers, extensions, emergency calling and texting setup. An app gets these tools when you allow Numbers and extensions, Emergency calling, Texting setup.
| Tool | What it does | Kind | Permissions it needs | Command |
|---|---|---|---|---|
| setup_status | What is left to set up, what each gap blocks, and where to fix it | Reads | Manage general settings | hq org setup-status |
| diagnose | Why a phone didn't ring: a number, an extension or one call Takes: number (text), extension (text), call (text) | Reads | Buy, port and release phone numbers, See every call | hq org diagnose |
| numbers | The organization's phone numbers: where each rings, E911 and texting | Reads | Buy, port and release phone numbers | hq phones list |
| number_search | Find numbers that can be bought, with their monthly price Takes: areaCode (text), city (text), state (text), contains (text), startsWith (text), endsWith (text), tollFree (yes or no), limit (number) | Reads | Buy, port and release phone numbers | hq phones search |
| number_routing | Point a number's calls at a flow, an extension or a queue; answers undo Takes: number (text, required), to (text, required), target (text), texts (text) | Changes, can be undone | Manage call routing | hq phones route |
| number_label | Rename a number (its label); answers undo Takes: number (text, required), label (text, required) | Changes, can be undone | Buy, port and release phone numbers | hq phones label |
| buy_number | Ask to buy a number (goes to the Approvals list) Takes: phoneNumber (text, required), label (text), summary (text) | Needs approval | Buy, port and release phone numbers | hq phones buy |
| release_number | Ask to release a number back to the carrier (goes to the Approvals list) Takes: number (text, required), reason (text), summary (text) | Needs approval | Buy, port and release phone numbers | hq phones release |
| port_number | Ask to start moving numbers in from another carrier (a port-in draft) Takes: numbers (list, required), losingCarrier (text, required), accountNumber (text), authorizedName (text, required), entityName (text), billingPhoneNumber (text), street (text), unit (text), city (text), state (text), postalCode (text), notes (text), summary (text) | Needs approval | Buy, port and release phone numbers | hq phones port |
| extensions | Every extension: who it rings, caller ID and no-answer rule Takes: extension (text) | Reads | Manage extensions and desk phones | hq extensions list |
| extension | Change an extension's name, caller ID or no-answer rule; answers undo Takes: extension (text, required), name (text), active (yes or no), ringSeconds (number), noAnswer (text), forwardTo (text), callerId (text) | Changes, can be undone | Manage extensions and desk phones | hq extensions set |
| create_extension | Add an extension Takes: name (text, required), number (text), person (text), kind (text) | Changes, can be undone | Manage extensions and desk phones | hq extensions create |
| devices | Desk phones and softphones: online or not, last seen, what they ring Takes: limit (number), cursor (text) | Reads | Manage extensions and desk phones | hq devices list |
| assign_device | Make a device ring for an extension; answers undo Takes: device (text, required), extension (text, required), priority (number) | Changes, can be undone | Manage extensions and desk phones | hq devices assign |
| unassign_device | Stop a device ringing for an extension; answers undo Takes: device (text, required), extension (text, required) | Changes, can be undone | Manage extensions and desk phones | hq devices unassign |
| conferences | The organization's conference rooms (names, size, active; never the PIN) | Reads | Any member | hq conferences list |
| e911_status | Is 911 ready, and which numbers and extensions lack an address | Reads | Manage 911 settings | hq emergency status |
| texting_readiness | Can the organization text yet: 10DLC brand and campaign state, numbers, what's blocking | Reads | Manage business texting | hq texting readiness |
| text_templates | Approved texts a healthcare organization may send (its own and HeyQuad's defaults) | Reads | Manage business texting | hq texting templates |
| create_text_template | Add an approved text; answers undo Takes: label (text, required), pattern (text, required) | Changes, can be undone | Manage business texting | hq texting add-template |
| edit_text_template | Change an approved text, or switch it off; answers undo Takes: template (text, required), label (text), pattern (text), active (yes or no) | Changes, can be undone | Manage business texting | hq texting edit-template |
| delete_text_template | Delete an approved text; answers undo Takes: template (text, required) | Changes, can be undone | Manage business texting | hq texting delete-template |
| text_destinations | Where texts land: the shared texting inboxes and who is in each | Reads | Manage call routing | hq texting destinations |
| edit_text_destination | Rename a texting destination or set who is in it; answers undo Takes: destination (text, required), name (text), members (list) | Changes, can be undone | Manage call routing | hq texting edit-destination |
| default_text_destination | Make a texting destination the default; answers undo Takes: destination (text, required) | Changes, can be undone | Manage call routing | hq texting default-destination |
| submit_texting_registration | Ask to submit the saved 10DLC brand or campaign (goes to the Approvals list; has fees) Takes: what (text, required), summary (text) | Needs approval | Manage business texting | hq texting register |
Team & billing
Members and roles, billing, integrations and mail setup. An app gets these tools when you allow Team, Billing, Integrations, Mail setup.
| Tool | What it does | Kind | Permissions it needs | Command |
|---|---|---|---|---|
| audit_log | Who changed what, through which app, and when Takes: person (text), via (text), area (text), since (date and time), until (date and time), limit (number) | Reads | See the audit log | hq audit log |
| mailboxes | The organization's mailboxes: who can read and send from each | Reads | Manage mailboxes | hq mail-setup mailboxes |
| mailbox_signature | The default signature of each mailbox, with a preview Takes: mailbox (text) | Reads | Manage mailboxes | hq mail-setup signature |
| set_mailbox_signature | Set or clear a mailbox's default signature (text, a layout or HTML); answers undo Takes: mailbox (text, required), text (text), clear (yes or no), layout (text), fields (list of JSON objects), socials (list of JSON objects), html (text), plainText (text), design (JSON object) | Changes, can be undone | Manage mailboxes | hq mail-setup set-signature |
| mailbox_signature_preview | Preview a mailbox's default signature, or a draft of one, with checks Takes: mailbox (text, required), layout (text), design (text) | Reads | Manage mailboxes | hq mail-setup preview-signature |
| brand_kit | The organization's brand kit for email signatures | Reads | Manage mailboxes | hq mail-setup brand-kit |
| set_brand_kit | Change the brand kit's colors, font, logo, website or address; answers undo Takes: colors (JSON object), font (text), logoImageId (text), website (text), address (text) | Changes, can be undone | Manage mailboxes | hq mail-setup set-brand-kit |
| brand_from_website | Suggest a brand kit from the organization's website Takes: url (text, required) | Reads | Manage mailboxes | hq mail-setup brand-from-website |
| saved_replies | The team's shared saved replies Takes: channel (text), mailbox (text) | Reads | Manage mailboxes | hq mail-setup replies |
| create_saved_reply | Add a shared saved reply; answers undo Takes: name (text, required), body (text, required), subject (text), channel (text), mailbox (text) | Changes, can be undone | Manage mailboxes | hq mail-setup create-reply |
| edit_saved_reply | Change a shared saved reply; answers undo Takes: savedReply (text, required), name (text), body (text), subject (text), channel (text), mailbox (text) | Changes, can be undone | Manage mailboxes | hq mail-setup edit-reply |
| delete_saved_reply | Delete a shared saved reply; answers undo Takes: savedReply (text, required) | Changes, can be undone | Manage mailboxes | hq mail-setup delete-reply |
| email_routes | How mail to each address is handled: mailbox or ticket, who is told, where it goes | Reads | Manage mailboxes | hq mail-setup routes |
| edit_email_route | Change an address's label, notifications, tags, queue or on/off; answers undo Takes: address (text, required), label (text), enabled (yes or no), allowCompose (yes or no), notify (text), notifyMembers (list), page (yes or no), tags (list), ticketType (text), queue (text) | Changes, can be undone | Manage mailboxes | hq mail-setup edit-route |
| members | Everyone in the organization: role, two-factor sign-in, last active, extensions Takes: member (text) | Reads | Manage people | hq members list |
| roles | The organization's roles and what each may do Takes: role (text) | Reads | Any member | hq roles list |
| permission_catalog | Every permission key with its label, by area, and what you may grant | Reads | Any member | hq roles catalog |
| invite_member | Ask to invite someone by email with a role (goes to the Approvals list) Takes: email (text, required), role (text, required), summary (text) | Needs approval | Manage people | hq members invite |
| change_role | Ask to change a member's role (goes to the Approvals list) Takes: member (text, required), role (text, required), summary (text) | Needs approval | Manage people | hq members set-role |
| create_role | Ask to create a custom role (goes to the Approvals list) Takes: name (text, required), description (text), permissions (list), template (text), summary (text) | Needs approval | Manage roles | hq roles create |
| edit_role | Ask to change a custom role's name or permissions (goes to the Approvals list) Takes: role (text, required), name (text), description (text), permissions (list), add (list), remove (list), summary (text) | Needs approval | Manage roles | hq roles edit |
| plan | The organization's plan: seats, add-ons, the AI tier, pools and the agreement | Reads | See billing | hq billing plan |
| invoices | The organization's invoices, newest first Takes: year (number), status (text), page (number) | Reads | See billing | hq billing invoices |
| invoice | One invoice with its lines, totals, status and payment Takes: invoice (text, required) | Reads | See billing | hq billing invoice |
| usage | This period's usage: pooled minutes, AI minutes, texts and spend Takes: days (number) | Reads | See billing | hq billing usage |
| next_invoice | The next invoice, as it would be issued now | Reads | See billing | hq billing next-invoice |
| change_addons | Ask to turn a minute, text or storage bundle on or off (goes to the Approvals list) Takes: addon (text, required), enabled (yes or no, required), quantity (number), summary (text) | Needs approval | Manage billing | hq billing change-addons |
| change_ai_tier | Ask to upgrade the AI receptionist tier (goes to the Approvals list) Takes: tier (text, required), summary (text) | Needs approval | Manage billing | hq billing ai-tier |
| integrations | Every integration: live and draft versions, connections and their last error Takes: integration (text) | Reads | See integrations | hq integrations list |
| integration_errors | Recent failed integration calls, with what the third party answered Takes: integration (text), errorClass (text), since (date and time), until (date and time), limit (number) | Reads | See integrations | hq integrations errors |
| integration_usage | Integration call volume, success rate, latency and daily quota Takes: integration (text), groupBy (text), since (date and time), until (date and time) | Reads | See integrations | hq integrations usage |
| edit_integration_draft | Save an integration's draft spec (checked first; nothing goes live) Takes: spec (JSON object, required) | Draft | See integrations, Build integrations | hq integrations apply |
| publish_integration | Ask to publish an integration's draft (goes to the Approvals list) Takes: integration (text, required), summary (text) | Needs approval | See integrations, Build integrations | hq integrations publish |
| test_integration_operation | Ask to test one operation against the third party (goes to the Approvals list) Takes: integration (text, required), operation (text, required), connection (text, required), inputs (JSON object), summary (text) | Needs approval | See integrations, Build integrations | hq integrations test |
Was this helpful?