Reveal Website API Key

Use a Website API Key for server-to-server integrations like Zapier, CRMs, or custom automations.

For assistants that support sign-in approval, use AI Tool Connections (MCP) instead of copying a key by hand.

Open the API key dialog

Create and manage keys

• Add a Key name (optional) to identify what uses the key.
• Select Create new key to generate a key.
• Copy the one-time reveal value immediately. It is not shown again.
• Use Revoke to disable a key without deleting it.
• Delete revoked keys to keep the list clean.

What API keys can access

Use the API key with the API base URL shown in the dialog when you want external tools to work with Hiveality data.

Current v1 coverage includes:

• Contacts, tags, subscriber lists, email preferences, custom fields, additional profile details, and addresses.
• Blog post drafts, targeted blog body edits, podcast episodes, publishing, scheduling, revisions, tags, categories, podcast collection settings, RSS feed import/sync, and podcast show-notes or article-draft helpers. Podcast episode creation can include categories and tags, and cleanup workflows can detach or delete reviewed categories and tags without deleting the posts themselves.
• Blog body edit workflows can read the post outline, update a specific heading, paragraph, link, or image, keep the rest of the post layout intact, and publish only when the request explicitly asks to publish.
• Blog category cleanup across multiple posts, including category deletion after review.
• Page lists, draft page creation, page-format guidance, page outlines, focused page text/link/image edits, page publishing, and page unpublishing. Page folder lookup, draft page filing, page renames, slug changes, and folder moves are supported for page organization workflows. Page outlines include linkable buttons, images, icons, shapes, logos, and text links, including empty CTA buttons that still need a destination. Page edit workflows can target a specific paragraph in a multi-paragraph block, preserve inline links while updating nearby copy, set or clear widget links, fill or replace image widgets after review, and remove a paragraph or section after approval.
• Clean HTML page imports that create or rebuild editable page drafts, use the website's saved fonts and colors where possible, import reachable image URLs, re-host supported external audio, video, and file links, report missing image slots, and can publish only when the request explicitly asks to publish.
• Shared website header, footer, and navigation lookup plus draft-first updates. Navigation edits can add, remove, reorder, or repoint menu items. Publishing a shared header, footer, or navigation change creates a rollback point first.
• Website capture tools that can return a full-page screenshot, rendered page source, or a compact page outline with headings, sections, images, links, and detected form fields.
• Site-wide brand style lookup and approved updates for colors, typography, button styles, and custom fonts. Brand style updates save a restore point before applying and refresh the live site.
• Site identity lookup and approved updates for the default logo, favicon, and social share image. Identity updates refresh the live site after save.
• SEO audit, page-health, broken-link review, metadata suggestions, and safe apply workflows.
• Team profiles and team profile categories.
• Hiveality docs search and full guide lookup, including docs links and dashboard links that external assistants can cite in responses.
• Business intelligence metrics and question answering across revenue, bookings, marketing, website traffic, and Google Search performance.
• Forms, form submissions, submission-setting read-back, form field and notification updates, protected form deletion, funnels, funnel creation, funnel publishing, funnel analytics, and funnel step creation or removal, including popup steps. Form and audience responses include clearer field labels and contact counts where available, so external tools can summarize responses with less manual lookup.
• Quizzes: list the quiz library, read full definitions, create or rebuild full quizzes, keep the existing title when rebuilding without a new name, update quiz sections, and simulate result outcomes for review.
• File Manager lookup, direct file uploads, URL imports, and file registration for images, PDFs, documents, audio, and other non-video assets.
• Video library lookup, video import from supported public URLs, direct video uploads, recent upload recovery, editable video metadata, and transcript lookup when transcripts are available.
• Product catalog lookup, product creation with prices and variant options, existing product price updates, variant option replacement, editable product content, SEO fields, product publish controls, product deletion, course-access product setup, plus bulk stock updates.
• Course, module, and lesson creation, one-shot course builds, lesson resource attachments, lesson resource edits, audio lessons, external video lesson URLs, publishing, resume-after-interruption, reorder, and confirmed cleanup workflows.
• Community members, posts, reported content review, report resolution, community setup, post categories, pinned posts, and event setup.
• Webhook event type discovery for integrations that need current trigger options, including board/card, community event, and member activity triggers.
• Email documents, AI email generation, rendered previews, duplication, test sends, and personalization-token cleanup for assistant/API-authored content.
• One-off personal email sends for a single recipient.
• Campaign drafts, scheduling controls, audience previews, duplication, metrics, and recipient logs.
• Boards, stage lookup by name, board creation and updates, board cards that use the saved default card setup, eligible teammate lookup for card assignment, pre-checked checklist items on created cards, comments, card moves, archive/unarchive actions, and stage automation summaries.
• Booking services, availability lookup, booking creation, rescheduling, cancellation, booking details, and booking notification settings. Service details include current confirmation, cancellation, reschedule, and reminder copy with the supported booking message tokens before an external workflow edits those messages.
• Social channel profiles, social post drafts, scheduling, publishing, cancellation, rescheduling, queue previews, repeating evergreen posts, LinkedIn/TikTok/YouTube/Pinterest/Threads posting where supported, Pinterest board lookup, account analytics, post analytics, AI caption drafts, and inbox thread/message/note reply workflows.
• Flows, contact enrollment, contact removal, contact moves between steps, full flow step review, flow activation/pausing, single-trigger setup, flow step add/update/delete/reorder actions, connected practice-management send actions, and AI flow planning/generation jobs.
• Website and funnel AI planning, generation, build jobs, and job status checks.
• Orders, access grants, events, redirect rules, webhook endpoints, and webhook event types.

API reference and safeguards

Open /docs/api for the interactive API reference. It loads the current OpenAPI reference and includes authentication, error, and rate-limit responses for each public endpoint.

Public URL import actions validate HTTP and HTTPS destinations before fetching files or videos, which helps catch unsafe or private-source URLs before an automation runs.

Public v1 routes also validate path IDs before running a request. When an ID is missing or malformed, the API returns a clear invalid_request response so external tools can correct the request before retrying.

For Zapier workflows, pair this guide with Zapier and Webhooks.

Long-running API jobs

Some API actions create work in the background, such as website generation, funnel generation, and flow generation.

• Plan first when the final content should be reviewed before building.
• Use the returned job ID to check status later.
• Share the editor or review URL from the completed job instead of waiting in the same automation step.
• Website generation jobs can finish with review recommendations instead of blocking the draft outright. Review the returned warnings before applying or publishing generated pages.
• Page imports from clean HTML return an advisory report with imported images, re-hosted media, missing image slots, forms found, simplifications, and review warnings. Share the preview link and resolve image warnings before publishing.
• Hiveality periodically checks generation jobs that stop reporting progress and returns a clear follow-up status, so automations are less likely to wait on a job that no longer has active work.
• For booking and board actions that can start downstream activity, check the related service, availability, or automation summary before making bulk changes.
• For booking notification edits, read the service first so the workflow can preserve existing reminders, use the correct booking message tokens, and choose whether system confirmation emails should send.
• For larger course or media imports, use direct upload workflows for local files and videos, attach returned file or video IDs to lessons, and use recent upload recovery if a video batch is interrupted.
• For audio lessons, attach the audio file ID directly to the lesson so the course player can render it as the primary lesson media.
• For larger course builds, approved automations can append missing modules, lessons, and resources to an existing course instead of creating a duplicate. Use confirmed cleanup actions only when a course, module, or lesson should be permanently removed.
• For product setup, create products as drafts first, pass prices in cents, use a currency already enabled in Store Settings, and publish only after reviewing the product in Store.
• When updating an existing product's prices through the API, send the complete desired price list for the product. Hiveality replaces the active prices with the list you provide.
• When replacing variant options through the API, send the complete desired option set. Products with completed purchases may need variant edits finished in Store so past order details stay intact.
• For flow step edits, read the current step graph first, then make the smallest add, update, delete, or reorder needed. Hiveality keeps active contacts on a valid step whenever possible.
• For flow trigger edits, resolve the exact tag, list, form, quiz, board, or booking service first. If the flow has an unpublished dashboard draft, publish or discard that draft before changing the trigger through an external workflow.

Security tips

• Keep API keys secret and store them in a secure vault.
• Rotate keys if you suspect exposure.
• Use one key per integration so you can revoke access cleanly.
• Prefer sign-in approval for AI assistant connections when the assistant supports it.