getting-started

Welcome to AxisSynapse

ESSENTIALEstimated read: 5 min· Updated 2026-06-02

Welcome to AxisSynapse

EssentialEveryone

AxisSynapse is one platform for your workforce, your operations, your compliance, and your numbers. These docs are the same content the in-product help drawer reads from, so a tip you find here is the same tip your employee, admin, developer, or auditor finds when they press ? inside the live product.

TL;DR — Use the search bar (or ⌘K / Ctrl+K) to jump straight to a task. Use the left rail to browse a module from start to end. Use the right rail to skip to a section on a long page. Every doc here is print-friendly, dark-mode-aware, and translation-ready.

Who these docs are for

Four audiences, all welcome on every page. The top-bar audience pill reorders the recommended reading without hiding anything.

FieldWhat it doesAccepted values / default
EmployeeDay-to-day users — filing requests, finding policies, picking up where they left off.Default starting points: Getting started, Account, the self-service surfaces of each module.
Workspace adminConfigures the workspace, manages access, runs cycles, exports compliance evidence.Default starting points: Platform, Reference / Audit codes, the admin surface of each module.
DeveloperBuilds against the platform — events, webhooks, the public API, automation scripts.Default starting points: Reference / API, Reference / Webhook events, the platform's developer portal.
AuditorReviews evidence — audit codes, retention policy, erasure controls, signed delivery logs.Default starting points: Reference / Audit codes (print-perfect), Platform / Audit-log retention, Platform / Account erasure.
Pick the role in the top bar to bias the left-rail order toward what matters to you.

How these docs are organized

The information architecture is three orthogonal axes that all point at the same content. Whichever axis matches how you think about the problem will get you there in a click or two.

FieldWhat it doesAccepted values / default
By roleThe top-bar audience pill. Switches the recommended order without hiding any pages.Persists to localStorage; mirrored to the URL via ?role=… so links remain shareable.
By moduleThe left rail groups every doc under the platform area it covers — Platform, Account, HCM, EEO, ELR, Inventory, Fixed Assets, Procurement, Ethics, Reference.Each module has its own home page with a card grid for sub-sections and a flat list for top-level pages.
By taskThe search bar and the docs home grid. Type a verb — configure, file, export, run — to surface the matching walkthrough.⌘K or Ctrl+K opens the palette from any page. Keyboard nav is fully supported.

The page-anatomy contract

Every walkthrough you'll read here follows the same anatomy so you can scan it in 20 seconds.

  1. Title and badges

    The first thing you see is the page title plus two badges: the plan tier the feature is available on, and the workspace role required to use it. If your plan or role doesn't match, you'll know before you read further.

  2. One-paragraph orientation

    What this surface is, who uses it, why it matters. Reading it twice is allowed.

  3. A bold TL;DR

    One or two sentences plus the time estimate to complete the task. Long pages start here when you're in a hurry.

  4. "Before you start"

    Prerequisites — prior configuration, material you should gather, other docs you may want open in another tab.

  5. Numbered Steps

    Each Step names the exact button label or field you'll see on screen. Steps never reference internal implementation; they describe the visible product.

  6. "Every field, explained"

    A table documenting every form field on the screen: label, what it does, accepted values, default. No field on any walkthrough is left undocumented.

  7. "What appears in the audit log"

    The audit codes the action emits, each linked to the canonical catalogue at Reference → Audit codes. Audit-relevant changes always show this section.

  8. "Common gotchas" + "Troubleshooting"

    Real patterns that catch real customers, plus the public error codes that may surface, linked to their remedy.

  9. Related docs

    Two to four cross-links to adjacent topics so you can finish what you started without backtracking to the rail.

What the badges mean

You'll see these everywhere — on doc pages, the home grid, search results.

FieldWhat it doesAccepted values / default
EssentialIncluded on every AxisSynapse plan.All workspaces, no add-on required.
ProfessionalAvailable on Professional and Enterprise plans.Adds SCIM, webhooks, custom branding, Security Console, and more.
EnterpriseAvailable on Enterprise.Adds network policy, attestation policy, configurable retention, and the advanced compliance surfaces.
AdminThe action requires a workspace admin role.Workspace admins are users with the Workspace admin role. Every workspace has at least one.
The page touches an action the audit log records.Click any badge to jump to the matching row in Reference / Audit codes.

Where the in-product help reads from

The drawer that appears when you press ? inside the live application loads from the same MDX corpus you're reading right now. Translation flows, dark mode, the role pill, search relevance — all of it is shared.

That means three things in practice:

  • A page that lands here is immediately available in-product, with no separate sync cycle.
  • A search query that finds a result here finds the same result inside the product (and vice versa).
  • Internal-only material does not appear in either surface. Every page is reviewed against a published disclosure policy before it's added; if you find anything that looks like a leak, please report it via the security contact on the marketing site.

Keyboard shortcuts you'll want today

FieldWhat it doesAccepted values / default
⌘ KOpen the search palette.Windows / Linux: Ctrl + K.
EscClose the palette or any open menu.Universal.
?Open the in-product help drawer (inside the live app).Reads from the same docs you're on now.
⌘ PPrint the current page (browser-native).Docs are designed for print; the chrome scrubs cleanly. Auditors use this to assemble evidence packs.
More shortcuts are catalogued in Keyboard and accessibility.

Accessibility posture

Every interactive surface is designed against WCAG 2.1 AA. That means a keyboard-only path through every page, screen-reader semantics on every component, sufficient color contrast in both light and dark mode, and a reduced-motion fallback that respects the system preference. Read more in Keyboard and accessibility.

What's safe to share

Every page here is public by design and SEO-indexed. We deliberately omit internal model names, monorepo paths, runtime implementation details, scoring weights, prompt internals, and anything else that would help a hostile competitor or attacker without helping a legitimate user. If you spot something that looks like a leak, please contact your account team or the security inbox linked from the marketing site.

Related