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 Assistant 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, publishing, scheduling, revisions, tags, and categories.
• Blog category cleanup across multiple posts, including category deletion after review.
• Page outlines, focused page text/link edits, page publishing, and page unpublishing. Page-edit workflows can target a specific paragraph in a multi-paragraph block, preserve inline links while updating nearby copy, and remove a paragraph or section after review.
• 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, funnels, and funnel analytics.
• 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, 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, editable product content, SEO fields, and product publish controls, plus bulk stock updates.
• Course, module, and lesson creation, one-shot course builds, lesson resource attachments, editing, publishing, resume-after-interruption, reorder, and confirmed cleanup workflows.
• Community members, posts, reported content review, and report resolution.
• Webhook event type discovery for integrations that need current trigger options.
• 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 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, and booking details.
• 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, flow steps, 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.

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.
• 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 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 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.

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.