# Payability Documentation

> Internal engineering documentation for Payability systems. Each section below is one component;
> pages are listed in navigation order. The full text of every page is in llms-full.txt.

## Actions Tools App

- [Actions Tools App](https://docx.payability.com/actionstools-app/index.html): What the Actions Tools App does, how it is put together, and where to read next.
- [System architecture](https://docx.payability.com/actionstools-app/architecture.html): The AWS resources in the stack, the code layers, and the rules that hold them together.
- [Request lifecycle](https://docx.payability.com/actionstools-app/request-lifecycle.html): What happens between a browser request and the JSON response, from cold start to async side effects.
- [API overview](https://docx.payability.com/actionstools-app/api/index.html): Authentication, context headers, the response envelope, pagination and the full route catalog.
- [Notes](https://docx.payability.com/actionstools-app/api/notes.html): Notes attached to a supplier (or any target): create, list, pin, edit, delete and bulk operations.
- [Tasks](https://docx.payability.com/actionstools-app/api/tasks.html): CRM tasks: the grid, per-supplier lists, creation (sync or async), updates, deletes, counts and history.
- [Comments](https://docx.payability.com/actionstools-app/api/comments.html): Threaded comments on tasks and notes, and the notifications they trigger.
- [Files](https://docx.payability.com/actionstools-app/api/files.html): File attachments: metadata stored here, file bytes stored by the B2B documents service.
- [Settings & folders](https://docx.payability.com/actionstools-app/api/settings.html): Global CRM settings (task statuses, priorities, email templates) and email template folders.
- [Notifications](https://docx.payability.com/actionstools-app/api/notifications.html): In-app notifications per target (usually a supplier): create, list with one filter, mark read or hidden.
- [Activity stream](https://docx.payability.com/actionstools-app/api/activity.html): One merged, time-ordered stream of notes, files, tasks, events and emails for a supplier.
- [Reports](https://docx.payability.com/actionstools-app/api/reports.html): Read-only reporting endpoints.
- [Worker Lambda & async tasks](https://docx.payability.com/actionstools-app/async/worker.html): How @async_task hands work to the Worker Lambda, the three event shapes the Worker accepts, and failure semantics.
- [Task counters](https://docx.payability.com/actionstools-app/async/counters.html): How the task grid's filter counts are kept without scanning the tasks table on every request.
- [DynamoDB tables](https://docx.payability.com/actionstools-app/data/dynamodb.html): Every table the service uses, its keys, indexes and naming per environment.
- [Event logger](https://docx.payability.com/actionstools-app/components/event-logger.html): The EventLoggerApp service: where task change events are written and the activity history is read from.
- [Messaging (email)](https://docx.payability.com/actionstools-app/components/messaging.html): The MessagingApp service: task notification emails out, supplier email history in.
- [B2B documents](https://docx.payability.com/actionstools-app/components/b2bdocument.html): The document storage service that holds the bytes of every file attachment.
- [Payability internal API](https://docx.payability.com/actionstools-app/components/payability-internal.html): The internal API (database_v2) used for permission checks and user lookups.
- [Slack](https://docx.payability.com/actionstools-app/components/slack.html): Direct-message task notifications through a Slack bot token.
- [Sentry](https://docx.payability.com/actionstools-app/components/sentry.html): Error reporting for both Lambda functions.
- [Local development](https://docx.payability.com/actionstools-app/operations/local-development.html): Install, test and run the API locally.
- [Configuration & secrets](https://docx.payability.com/actionstools-app/operations/configuration.html): Where every setting comes from, how secrets reach the code, and how to change them.
- [Deployment](https://docx.payability.com/actionstools-app/operations/deployment.html): How the SAM stack is built and deployed, by GitHub Actions and by hand, and what CI needs.
- [Zappa → SAM cutover](https://docx.payability.com/actionstools-app/operations/zappa-cutover.html): The one-time runbook that moves stage and production from the Zappa Lambdas to the SAM stacks without downtime.
- [Observability](https://docx.payability.com/actionstools-app/operations/observability.html): Where logs, errors and metrics for both functions live, and what to watch.
- [Troubleshooting](https://docx.payability.com/actionstools-app/operations/troubleshooting.html): Symptoms, causes and fixes for the failures seen so far.
- [Writing these docs](https://docx.payability.com/actionstools-app/contributing/documentation.html): How this Antora component is laid out, how to preview it, and the conventions to follow.
- [Settings & secrets reference](https://docx.payability.com/actionstools-app/reference/settings.html): Every environment variable and secret key the service reads, where it is set, and its value per environment.
- [Source map](https://docx.payability.com/actionstools-app/reference/source-map.html): Where to find things in the repository.
- [Glossary](https://docx.payability.com/actionstools-app/reference/glossary.html): Terms used in the code and these docs.

## Automatic Underwriting Tool

- [Automatic Underwriting Tool](https://docx.payability.com/automatic-uw-tool/index.html): What the Automatic Underwriting Tool does, how it is put together, and where to read next.
- [System architecture](https://docx.payability.com/automatic-uw-tool/architecture.html): The two containers, the four layers, and the cross-cutting concerns.
- [Request lifecycle](https://docx.payability.com/automatic-uw-tool/request-lifecycle.html): End-to-end traces of the two shapes of execution: process-driven and webhook-driven.
- [Domain model: processes & tasks](https://docx.payability.com/automatic-uw-tool/domain-model.html): The task framework, the two factories, task inputs and outputs, and failure handling.
- [Process catalog](https://docx.payability.com/automatic-uw-tool/processes/index.html): The underwriting processes, who may start them, and what each one writes.
- [validate_identity_document (Au10tix)](https://docx.payability.com/automatic-uw-tool/processes/validate-identity-document-au10tix.html): Verify an uploaded government ID with Au10tix and match the name against the supplier owner.
- [validate_identity_document (Entrust / Onfido)](https://docx.payability.com/automatic-uw-tool/processes/validate-identity-document-entrust.html): The hosted Entrust identity-verification flow, its webhook, and the asynchronous aftermath task.
- [validate_personal_information (KYC)](https://docx.payability.com/automatic-uw-tool/processes/validate-personal-information.html): Confirm a supplier owner's PII against Thomson Reuters CLEAR EIDV records, field by field.
- [download_personal_background_report](https://docx.payability.com/automatic-uw-tool/processes/download-personal-background-report.html): Pull a Thomson Reuters CLEAR personal background report and score it into access and advance verdicts.
- [download_business_background_report](https://docx.payability.com/automatic-uw-tool/processes/download-business-background-report.html): Pull and archive a Thomson Reuters CLEAR business-entity background report.
- [API overview](https://docx.payability.com/automatic-uw-tool/api/index.html): The FastAPI application, its routers, authentication, authorization and the full route table.
- [Task endpoints](https://docx.payability.com/automatic-uw-tool/api/tasks.html): Execute a process, poll it, read or purge its results, and override its verdict.
- [Tool endpoints](https://docx.payability.com/automatic-uw-tool/api/tools.html): List the verification tools and their statuses for a supplier owner.
- [Entrust endpoints](https://docx.payability.com/automatic-uw-tool/api/entrust.html): Create a hosted Entrust identity-verification session and receive Onfido completion callbacks.
- [Schemas](https://docx.payability.com/automatic-uw-tool/api/schemas.html): The pydantic request and response models of the HTTP layer.
- [SWF orchestration](https://docx.payability.com/automatic-uw-tool/events/swf-orchestration.html): How the asynchronous handle step is scheduled, polled, executed and reported.
- [EventBridge events](https://docx.payability.com/automatic-uw-tool/events/eventbridge-events.html): The outbound event catalog, payload shapes, and how to add or consume an event.
- [DynamoDB tables](https://docx.payability.com/automatic-uw-tool/data/dynamodb.html): The four tables, their keys, item shapes, statuses and access patterns.
- [S3 datalake](https://docx.payability.com/automatic-uw-tool/data/s3-datalake.html): Where raw vendor responses are archived, the key conventions, and how they are deleted.
- [Component layer](https://docx.payability.com/automatic-uw-tool/components/index.html): The integration layer — every client that talks to something outside this process.
- [Au10tix](https://docx.payability.com/automatic-uw-tool/components/au10tix.html): The Au10tix BOS4 identity-document verification client and its request template.
- [Entrust / Onfido](https://docx.payability.com/automatic-uw-tool/components/entrust.html): The Entrust Identity Verification (Onfido) client: applicants, workflow runs, artifacts and step hydration.
- [HubSpot](https://docx.payability.com/automatic-uw-tool/components/hubspot.html): The best-effort HubSpot CRM client that mirrors Entrust verification state onto a supplier's contact.
- [Supplier event logger](https://docx.payability.com/automatic-uw-tool/components/event-logger.html): The best-effort emitter of supplier-scoped events to Payability's internal EventLogger service.
- [Thomson Reuters CLEAR](https://docx.payability.com/automatic-uw-tool/components/thomson-reuters.html): The CLEAR S2S client — XML over mutual TLS — and the request templates.
- [AWS clients](https://docx.payability.com/automatic-uw-tool/components/aws.html): The DynamoDB, S3, SWF and EventBridge wrappers, plus the purge helpers.
- [Payability internal services](https://docx.payability.com/automatic-uw-tool/components/payability-internal.html): The internal REST API, the document service, and the B2B Task Manager.
- [Auth & permissions](https://docx.payability.com/automatic-uw-tool/components/auth-permissions.html): Token validation, process sources, permission codes, and webhook signature trust.
- [Utilities](https://docx.payability.com/automatic-uw-tool/components/utilities.html): Retry, logging, metrics and the small helpers under utils/.
- [Local development](https://docx.payability.com/automatic-uw-tool/operations/local-development.html): Bootstrap the project, run both containers, and use the Makefile targets.
- [Configuration & secrets](https://docx.payability.com/automatic-uw-tool/operations/configuration.html): How Dynaconf loads settings per environment, and how secrets reach the containers.
- [Deployment](https://docx.payability.com/automatic-uw-tool/operations/deployment.html): The CodeBuild pipeline, the two Docker images, and the ECS/CodeDeploy artifacts.
- [Observability](https://docx.payability.com/automatic-uw-tool/operations/observability.html): The metrics, logs, audit trails and error reporting available for this service.
- [Troubleshooting](https://docx.payability.com/automatic-uw-tool/operations/troubleshooting.html): Symptom-to-cause table for the failures this service actually produces.
- [Python standards](https://docx.payability.com/automatic-uw-tool/contributing/python-standards.html): The data-structure and production rules new code in this repository must follow.
- [Testing](https://docx.payability.com/automatic-uw-tool/contributing/testing.html): The three test suites, how to run them, and what the coverage gate covers.
- [Writing these docs](https://docx.payability.com/automatic-uw-tool/contributing/documentation.html): How this Antora component is laid out, how to preview it, and the conventions to follow.
- [Settings & secrets reference](https://docx.payability.com/automatic-uw-tool/reference/settings.html): Every Dynaconf setting and every secret, with its production and dev value.
- [Source map](https://docx.payability.com/automatic-uw-tool/reference/source-map.html): Where to find things in the repository, and which page documents each file.
- [External APIs](https://docx.payability.com/automatic-uw-tool/reference/external-apis.html): The external systems this service depends on, with endpoints, auth and specs.
- [Glossary](https://docx.payability.com/automatic-uw-tool/reference/glossary.html): The vocabulary used across this component and in the code.

## Dialer V2

- [Dialer V2](https://docx.payability.com/dialer-v2/index.html): AI-powered outbound campaign management platform — architecture, business logic, data model, APIs, events and operations.
- [Technology stack](https://docx.payability.com/dialer-v2/tech-stack.html): Runtime, framework, data and third-party services that make up Dialer V2.
- [Repository map](https://docx.payability.com/dialer-v2/repository-map.html): Where everything lives in the Dialer V2 repository.
- [Glossary](https://docx.payability.com/dialer-v2/glossary.html): Domain vocabulary used throughout Dialer V2.
- [About this documentation](https://docx.payability.com/dialer-v2/doc-conventions.html): How this Antora component is structured, built and extended.
- [Architecture overview](https://docx.payability.com/dialer-v2/architecture/index.html): System context, containers and the shape of the Dialer V2 codebase.
- [Layering rules](https://docx.payability.com/dialer-v2/architecture/layers.html): The three-layer rule, error taxonomy and where each kind of logic belongs.
- [Request lifecycle](https://docx.payability.com/dialer-v2/architecture/request-lifecycle.html): What happens between a browser request and a database write.
- [Multi-tenancy](https://docx.payability.com/dialer-v2/architecture/multi-tenancy.html): How workspace isolation is resolved and enforced.
- [Asynchronous runtime](https://docx.payability.com/dialer-v2/architecture/async-runtime.html): How work escapes the request/response cycle — Inngest, cron broadcasters, the Redis counter and SQS.
- [Cross-cutting concerns](https://docx.payability.com/dialer-v2/architecture/cross-cutting.html): Observability, time handling, caching, performance and scalability.
- [Business logic](https://docx.payability.com/dialer-v2/domain/index.html): The rules Dialer V2 enforces, organised by capability.
- [Call campaigns](https://docx.payability.com/dialer-v2/domain/call-campaigns.html): Campaign configuration, the broadcast loop and the dial pipeline.
- [Target lifecycle](https://docx.payability.com/dialer-v2/domain/target-lifecycle.html): The CampaignTarget state machine, retry strategy, call windows and leasing.
- [Call analysis](https://docx.payability.com/dialer-v2/domain/call-analysis.html): How LLM analysis grades a call, where results are stored, and how to re-run them in bulk.
- [AI agents and test cases](https://docx.payability.com/dialer-v2/domain/ai-agents.html): Versioned caller and analysis agents, Retell synchronisation, regression test cases and prompt suggestions.
- [Phone numbers](https://docx.payability.com/dialer-v2/domain/phone-numbers.html): Outbound number pool, selection algorithm, purchase and release, SMS enablement.
- [Email campaigns](https://docx.payability.com/dialer-v2/domain/email-campaigns.html): Email campaign configuration, the broadcast loop, the send workflow and content variations.
- [Email deliverability](https://docx.payability.com/dialer-v2/domain/email-deliverability.html): Sending domains, email accounts, the four-level cap model, suppression and per-account statistics.
- [Email inbox and replies](https://docx.payability.com/dialer-v2/domain/email-inbox.html): Inbound reply capture, threading, categorisation and the in-app inbox.
- [Nurture sequences](https://docx.payability.com/dialer-v2/domain/sequences.html): Sequence templates, step channels, data gates, enrollment and durable execution.
- [Contacts, sellers and registries](https://docx.payability.com/dialer-v2/domain/contacts.html): The contact graph — sellers, contacts, phone and email registries, and CRM synchronisation.
- [Sales reps and follow-up tasks](https://docx.payability.com/dialer-v2/domain/sales-reps.html): Rep identity across CRM systems, task assignment, escalation and hand-off.
- [Reporting and activity](https://docx.payability.com/dialer-v2/domain/reporting.html): The reporting views, the metrics they expose, and the unified activity feed.
- [Data model](https://docx.payability.com/dialer-v2/data/index.html): Prisma schema conventions, model inventory and migration workflow.
- [Enums](https://docx.payability.com/dialer-v2/data/enums.html): Every Prisma enum, its values and where they are consumed.
- [Tenancy and identity models](https://docx.payability.com/dialer-v2/data/tenancy-identity.html): Subscription, SubscriptionUser and Profile.
- [Calling models](https://docx.payability.com/dialer-v2/data/calling.html): Campaign, CampaignTarget, Call, CallAiAgentAnalysisResult, PhoneNumbers, BlockedPhoneNumbers and WebhookEvent.
- [AI agent and config models](https://docx.payability.com/dialer-v2/data/ai-agents.html): AiAgent, AiAgentVersion, AgentTestCase and Configs.
- [Contact and registry models](https://docx.payability.com/dialer-v2/data/contacts.html): Seller, Supplier, Contact, TargetPhoneNumbers, TargetEmails and Activity.
- [Email models](https://docx.payability.com/dialer-v2/data/email.html): EmailCampaignTarget, EmailVariation, Domain, EmailSendingDomain and Emails.
- [Sequence and task models](https://docx.payability.com/dialer-v2/data/sequences.html): SequenceTemplate, SequenceTemplateStep, ContactSequence, ContactSequenceStep, SalesRep and FollowUpTask.
- [Segmentation models](https://docx.payability.com/dialer-v2/data/segmentation.html): Segment, SegmentMembership, SegmentStrategy, SegmentRun and ReengagementDailyListEntry.
- [API reference](https://docx.payability.com/dialer-v2/api/index.html): Conventions, authentication, pagination and error handling for the Dialer V2 HTTP API.
- [Auth and workspace endpoints](https://docx.payability.com/dialer-v2/api/auth-workspace.html): Registration, session, current user, workspace selection and member management.
- [Campaigns and targets](https://docx.payability.com/dialer-v2/api/campaigns.html): Call campaign CRUD, target management, coverage and the broadcast trigger.
- [Call endpoints](https://docx.payability.com/dialer-v2/api/calls.html): Listing, filtering, inspecting and re-analysing calls.
- [AI agent endpoints](https://docx.payability.com/dialer-v2/api/ai-agents.html): Agent CRUD, versions, analysis results, issues, prompt suggestions, test cases and Retell voices.
- [Contact and registry endpoints](https://docx.payability.com/dialer-v2/api/contacts.html): Contacts, sellers, the phone and email registries, and the cross-campaign target list.
- [Email campaign endpoints](https://docx.payability.com/dialer-v2/api/email-campaigns.html): Email campaign CRUD, recipients, variations, duplication and the broadcast trigger.
- [Email content and domain endpoints](https://docx.payability.com/dialer-v2/api/email-infrastructure.html): Reusable templates, the variation library, domains, sending accounts and unsubscribe.
- [Email inbox endpoints](https://docx.payability.com/dialer-v2/api/emails.html): Listing, reading and sending individual email messages.
- [Sequence endpoints](https://docx.payability.com/dialer-v2/api/sequences.html): Sequence template CRUD and contact enrollment lifecycle.
- [Sales rep and task endpoints](https://docx.payability.com/dialer-v2/api/people.html): Rep CRUD, profile matching, and the follow-up task board.
- [Phone number endpoints](https://docx.payability.com/dialer-v2/api/phone-numbers.html): Outbound number pool listing, purchase, update and release.
- [Report and activity endpoints](https://docx.payability.com/dialer-v2/api/reports.html): Reporting endpoints, their source views, and the unified activity feed.
- [Webhooks, cron and internal endpoints](https://docx.payability.com/dialer-v2/api/webhooks.html): Inbound provider webhooks, scheduled jobs, the Inngest handler and internal-only routes.
- [MCP tool server](https://docx.payability.com/dialer-v2/api/mcp.html): The JSON-RPC 2.0 Model Context Protocol endpoint, its tools and how to add one.
- [Events](https://docx.payability.com/dialer-v2/events/index.html): Inbound webhook ingestion, the dispatcher registries and the handlers they route to.
- [Retell AI events](https://docx.payability.com/dialer-v2/events/retell.html): The call_analyzed handler — extraction, state decision, CRM hand-off and the emitted Inngest event.
- [Resend email events](https://docx.payability.com/dialer-v2/events/resend.html): The Resend webhook dispatcher, its handlers and inbound reply correlation.
- [Nooks events](https://docx.payability.com/dialer-v2/events/nooks.html): Ingesting human-dialer call outcomes, rep attribution, AI analysis and closed-lost CRM updates.
- [Telnyx AI assistant events](https://docx.payability.com/dialer-v2/events/telnyx.html): Store-only ingestion of Telnyx AI assistant call webhooks.
- [ElevenLabs post-call events](https://docx.payability.com/dialer-v2/events/elevenlabs.html): Store-only ingestion of ElevenLabs Agents post-call webhooks.
- [CRM queue and HubSpot events](https://docx.payability.com/dialer-v2/events/crm-sqs.html): Outbound CRM messages over SQS, inbound HubSpot webhooks, and the conditional-publish rule.
- [Adding a handler](https://docx.payability.com/dialer-v2/events/extending.html): How to register a new webhook event type, and what to check before you do.
- [Workflows](https://docx.payability.com/dialer-v2/workflows/index.html): The durable Inngest functions, their triggers, guards and configuration.
- [callTarget](https://docx.payability.com/dialer-v2/workflows/call-target.html): The dial pipeline — window check, pre-validation, call initiation and counter hygiene.
- [callEndedAnalysis](https://docx.payability.com/dialer-v2/workflows/call-ended-analysis.html): Post-call work — the double tap, contact and registry updates, and AI analysis.
- [Email workflows](https://docx.payability.com/dialer-v2/workflows/email.html): emailSend, emailCampaignDuplicate and emailCampaignImportSegment.
- [sequenceExecute](https://docx.payability.com/dialer-v2/workflows/sequence-execute.html): Running a contact's entire nurture journey in one durable run.
- [Analysis, purchase and utility workflows](https://docx.payability.com/dialer-v2/workflows/utility.html): nooksCallAnalysis, purchasePhoneNumber, batchCallAnalysisWorkflow and the scaffolding functions.
- [Integrations](https://docx.payability.com/dialer-v2/integrations/index.html): Every external system Dialer V2 talks to, and how it is wired.
- [Retell AI](https://docx.payability.com/dialer-v2/integrations/retell.html): AI voice calling, SMS chats, agent management and phone-number import.
- [Resend](https://docx.payability.com/dialer-v2/integrations/resend.html): Campaign and transactional email, templates, topics, contacts and delivery webhooks.
- [HubSpot](https://docx.payability.com/dialer-v2/integrations/hubspot.html): CRM synchronisation over SQS, inbound webhooks, and the direct calls that remain.
- [Carriers, MessagingApp, Nooks and JustCall](https://docx.payability.com/dialer-v2/integrations/telephony.html): Number acquisition over Twilio and Plivo, the MessagingApp microservice, Nooks ingestion and the JustCall legacy.
- [Platform services](https://docx.payability.com/dialer-v2/integrations/platform-services.html): Supabase, the Vercel AI Gateway, BigQuery, AWS SQS, Redis and Sentry.
- [Security](https://docx.payability.com/dialer-v2/security/index.html): The security model — who can call what, and how each boundary is enforced.
- [Authentication](https://docx.payability.com/dialer-v2/security/authentication.html): Supabase Auth, the API-based session flow, middleware protection and the email-domain gate.
- [Authorization](https://docx.payability.com/dialer-v2/security/authorization.html): Workspace membership, roles and what each role may do.
- [Secrets and webhook verification](https://docx.payability.com/dialer-v2/security/secrets-and-webhooks.html): Machine-to-machine secrets, provider signature verification and secret handling.
- [Frontend](https://docx.payability.com/dialer-v2/frontend/index.html): How the dashboard is built — rendering model, data flow and component organisation.
- [Routes](https://docx.payability.com/dialer-v2/frontend/routes.html): Every dashboard route and what it shows.
- [Data layer](https://docx.payability.com/dialer-v2/frontend/data-layer.html): React Query hooks, query keys, cache invalidation and schema validation.
- [UI conventions and theming](https://docx.payability.com/dialer-v2/frontend/ui-and-theming.html): shadcn/ui composition, styling rules and the light/dark token system.
- [Operations](https://docx.payability.com/dialer-v2/ops/index.html): Running Dialer V2 — environment, local setup, deployment, scheduled work and incident response.
- [Environment variables](https://docx.payability.com/dialer-v2/ops/environment-variables.html): Every variable, what reads it, and what breaks when it is missing.
- [Local development](https://docx.payability.com/dialer-v2/ops/local-development.html): Getting Dialer V2 running on a laptop, and what works without every integration.
- [Deployment and scheduled jobs](https://docx.payability.com/dialer-v2/ops/deployment-and-jobs.html): Build pipeline, Vercel configuration, scheduled Inngest jobs and the pg_cron schedulers.
- [Runbooks](https://docx.payability.com/dialer-v2/ops/runbooks.html): Routine operational procedures.
- [Troubleshooting](https://docx.payability.com/dialer-v2/ops/troubleshooting.html): Diagnosing the failures that actually happen.

## EventLogger Rules

- [EventLogger Rules](https://docx.payability.com/eventlogger-rules/index.html): Event rule engine for the Payability platform: matches EventLogger events against configurable rules and runs their actions.
- [System architecture](https://docx.payability.com/eventlogger-rules/architecture.html): How the EventLogger Rules functions, event sources and data stores fit together.
- [Event processing and rules](https://docx.payability.com/eventlogger-rules/event-processing.html): What happens to an event: the pipeline stages, rule matching, actions, history and the watchdog.
- [REST API](https://docx.payability.com/eventlogger-rules/api.html): Endpoints served by ApiFunction, their authentication and where they are published.
- [Repository layout](https://docx.payability.com/eventlogger-rules/repository-layout.html): Where things live in the repository and how the source tree maps to the Lambda artifact.
- [Configuration and secrets](https://docx.payability.com/eventlogger-rules/configuration.html): Where each setting comes from: samconfig.toml, the template's environment mapping, environment variables and the common/crm secret.
- [Local development](https://docx.payability.com/eventlogger-rules/development.html): Setting up the project, the make targets, tests and running the API locally.
- [Build and deployment](https://docx.payability.com/eventlogger-rules/deployment.html): How the Lambda artifact is built, how GitHub Actions deploys each environment, and the OIDC follow-up.
- [Security](https://docx.payability.com/eventlogger-rules/security.html): Authentication, IAM boundaries, secrets handling and supply-chain controls.
- [Writing these docs](https://docx.payability.com/eventlogger-rules/docs-contributing.html): How this Antora component is structured, consumed and extended.
- [Operations](https://docx.payability.com/eventlogger-rules/operations/index.html): Monitoring the stacks and the runbooks for cutover, rollback and decommissioning.
- [Zappa to SAM cutover](https://docx.payability.com/eventlogger-rules/operations/cutover.html): Moving the new-rules app from the Zappa deployments to the SAM stacks without skipping or repeating events.
- [Rollback](https://docx.payability.com/eventlogger-rules/operations/rollback.html): Returning production from the SAM stack to the Zappa deployment after a cutover.
- [Decommissioning Zappa](https://docx.payability.com/eventlogger-rules/operations/decommission.html): Removing the Zappa deployments and their leftovers after the soak period.

## Internal Admin

- [Internal Admin](https://docx.payability.com/internal-admin/index.html): The Payability internal administration client — architecture, business logic and operations.
- [What the application does](https://docx.payability.com/internal-admin/what-it-does.html): The business capabilities the Internal Admin exposes, in the order staff encounter them.
- [Orientation for new developers](https://docx.payability.com/internal-admin/orientation.html): How to find your way around the codebase and make a first safe change.
- [Documentation map](https://docx.payability.com/internal-admin/documentation-map.html): Every page in this component, what it covers, and when to reach for it.
- [Glossary](https://docx.payability.com/internal-admin/glossary.html): Domain and codebase vocabulary used throughout the Internal Admin.
- [Architectural overview](https://docx.payability.com/internal-admin/architecture/overview.html): The layers of the Internal Admin, how a request flows through them, and the rules that hold between them.
- [Technology stack](https://docx.payability.com/internal-admin/architecture/tech-stack.html): Every significant dependency, why it is present, and what it constrains.
- [Module map](https://docx.payability.com/internal-admin/architecture/module-map.html): Every top-level module, what it owns, and the rules for where new code goes.
- [Bootstrap and composition root](https://docx.payability.com/internal-admin/architecture/bootstrap.html): What happens between page load and the first rendered screen, and everything AppModule wires together.
- [Routing and navigation](https://docx.payability.com/internal-admin/architecture/routing.html): How URLs map to screens, how routes are admitted, and the conventions every route table follows.
- [State management (NgRx)](https://docx.payability.com/internal-admin/architecture/state-management.html): The NgRx 4 patterns in use, every state slice, and the idioms to copy.
- [HTTP layer and services](https://docx.payability.com/internal-admin/architecture/http-and-services.html): How the application talks to its backends — interceptors, service conventions, abstractions and error mapping.
- [Data modelling and serialisation](https://docx.payability.com/internal-admin/architecture/data-modeling.html): How API payloads become application objects, the cerialize casing mechanics, and the three model styles in the codebase.
- [UI composition and layout](https://docx.payability.com/internal-admin/architecture/ui-composition.html): The application shell, the panels that surround the router outlet, the four table generations, and the shared form and dialog machinery.
- [Integration landscape](https://docx.payability.com/internal-admin/architecture/integration-landscape.html): Every backend service and third party the Internal Admin talks to, what it is used for, and how it is reached.
- [Architectural decisions and constraints](https://docx.payability.com/internal-admin/architecture/decisions.html): The standing decisions that shape this codebase, why they hold, and the known debt.
- [Business domains](https://docx.payability.com/internal-admin/domains/index.html): Index of the business logic documented in this component, and where the rules actually live.
- [Suppliers](https://docx.payability.com/internal-admin/domains/suppliers.html): The central entity, its workspace, its store slice, and the partial-editing mechanism every supplier tab uses.
- [Onboarding and KYC](https://docx.payability.com/internal-admin/domains/supplier-onboarding.html): Bringing a supplier from signed-up to fundable — templates, compliance actions, document verification, marketplace access and 2FA.
- [Underwriting](https://docx.payability.com/internal-admin/domains/supplier-underwriting.html): Deciding whether and how much to fund — initial and daily underwriting, background reports, UCC filings, and the tooling around them.
- [Advances and offers](https://docx.payability.com/internal-admin/domains/advances.html): The advance lifecycle and the progressive-pricing calculator — the largest piece of genuine business arithmetic in the front end.
- [Supplier payments and deposit accounts](https://docx.payability.com/internal-admin/domains/supplier-payments.html): How money leaves Payability for a supplier — payment configurations, deposit accounts, bank verification and payment features.
- [Fees, reserves and contracts](https://docx.payability.com/internal-admin/domains/fees-and-reserves.html): How Payability's pricing is configured for a supplier — funding particulars, purchase and payment fees, per-marketplace reserves and minimum fees, and long-term contracts.
- [Card programmes](https://docx.payability.com/internal-admin/domains/cards.html): The three card programmes — EFS, Marqeta and Airwallex — their statuses, issuing flows and the Airwallex onboarding state machine.
- [Lifecycle actions and transactions](https://docx.payability.com/internal-admin/domains/supplier-lifecycle.html): Changing a supplier's standing — hide, suspend, lock, cancel, write off, delete, win back — and the global Actions menu money operations.
- [Marketplaces and gateways](https://docx.payability.com/internal-admin/domains/marketplaces.html): The marketplace catalogue, payment gateways, the supplier-to-marketplace link, and marketplace statements.
- [Payment processes and batches](https://docx.payability.com/internal-admin/domains/processes.html): How money actually leaves Payability — fund-transfer batches, their lifecycle, per-payment review and the payment file.
- [Balance approval](https://docx.payability.com/internal-admin/domains/balance-approval.html): The treasury review gate before money moves — the ML recommendation, the risk signals shown, and how a decision is recorded.
- [CRM tools and tasks](https://docx.payability.com/internal-admin/domains/crm.html): The activity timeline attached to any entity, the task workflow that drives staff work queues, and how the normalised CRM store works.
- [Emails and messaging](https://docx.payability.com/internal-admin/domains/emails.html): Outbound email — the log, preview and approval workflow, batch sends, templates and per-supplier preferences.
- [Reports](https://docx.payability.com/internal-admin/domains/reports.html): Configuration-driven internal reports over database views, external report feeds, the waiting-suppliers report, and CSV export.
- [Manage (back-office configuration)](https://docx.payability.com/internal-admin/domains/manage.html): The administration area — bulk imports, users and permissions, global settings, configs, onboarding templates, contracts, fee settings, month-end close and the event stream.
- [Underwriting tracker](https://docx.payability.com/internal-admin/domains/underwriting-tracker.html): The cross-supplier underwriting queue — a fully EVA-rendered screen behind a feature flag.
- [DEV Admin](https://docx.payability.com/internal-admin/domains/admin.html): Developer-only tooling — runtime feature-flag switching for both Internal Admin and EVA, plus a QA surface.
- [Authentication and session](https://docx.payability.com/internal-admin/platform/authentication.html): How a user signs in, how the session token is carried, when it expires, and what happens on logout.
- [Authorisation and permissions](https://docx.payability.com/internal-admin/platform/authorization.html): How access is gated — ngx-permissions, the two deny-filter permissions, supplier-scoped and sub-permissions, and where enforcement actually happens.
- [Feature flags](https://docx.payability.com/internal-admin/platform/feature-flags.html): The three flag layers, their precedence, and the four ways to apply a flag.
- [Events](https://docx.payability.com/internal-admin/platform/events.html): The domain event stream, and event rules — the automation layer that reacts to events by creating tasks, sending emails, editing suppliers or pushing to EventBridge.
- [Real-time streams (SSE)](https://docx.payability.com/internal-admin/platform/realtime.html): Server-sent events for long-running job progress, the in-app publish/subscribe bus, and the polling that fills the gaps.
- [Iframe messaging and EVA](https://docx.payability.com/internal-admin/platform/iframe-messaging.html): The micro-front-end seam — how EVA is embedded, authenticated, configured and resized, and the full postMessage protocol.
- [Error handling](https://docx.payability.com/internal-admin/platform/error-handling.html): The layers that catch, parse, present and record errors — and why a server error often produces two toasts.
- [Caching and browser persistence](https://docx.payability.com/internal-admin/platform/caching-and-persistence.html): Every storage key the application writes, what clears it, and the in-memory caches that are easy to miss.
- [Observability and analytics](https://docx.payability.com/internal-admin/platform/observability.html): What the application reports about itself — Segment, Google Analytics, the KYC guardrail audit trail, version reporting and the VPN check.
- [Shared library](https://docx.payability.com/internal-admin/platform/shared-library.html): Inventory of `src/app/shared` — what is there, which generation is current, and what to reach for.
- [Local development](https://docx.payability.com/internal-admin/ops/local-development.html): Getting the application running on your machine, running it against EVA, and the constraints that bite on the first try.
- [Environments and configuration](https://docx.payability.com/internal-admin/ops/environments.html): How `src/environments/environment.ts` is generated, what the dev and production templates set, and how to add a configuration key.
- [Build and deployment](https://docx.payability.com/internal-admin/ops/build-and-deploy.html): Build configurations, the CodeBuild specs, how assets reach S3, and how a release is versioned.
- [Testing](https://docx.payability.com/internal-admin/ops/testing.html): The unit-test setup and idioms, coverage reporting, and the current state of the Cypress suite.
- [Code conventions](https://docx.payability.com/internal-admin/ops/conventions.html): Naming, structure, SCSS, lint and format rules, and the Git and PR conventions this repository enforces.
- [Spec-driven workflow](https://docx.payability.com/internal-admin/ops/spec-driven-workflow.html): The five agent phases, the `.specs/` formats, the checkpoints, and where the tool-specific definitions live.
- [Troubleshooting](https://docx.payability.com/internal-admin/ops/troubleshooting.html): The recurring failure modes — build, runtime, auth, EVA, flags and tests — with the fix for each.
- [Route catalogue](https://docx.payability.com/internal-admin/reference/routes.html): Every route in the application, its component, guards and permission clause.
- [Store action catalogue](https://docx.payability.com/internal-admin/reference/store-actions.html): Every NgRx slice, its action types, selectors and the effects class that handles them.
- [Services and API endpoints](https://docx.payability.com/internal-admin/reference/services-and-endpoints.html): Every service, the base URL it uses, and the endpoints it calls.
- [Environment configuration keys](https://docx.payability.com/internal-admin/reference/environment-variables.html): Every IEnvironment key, its source shell variable, and its dev and production values.
- [Feature flag catalogue](https://docx.payability.com/internal-admin/reference/feature-flag-catalog.html): Every flag in the FEATURE_FLAGS enum, what it gates, and where it is checked.
- [Permission catalogue](https://docx.payability.com/internal-admin/reference/permission-catalog.html): Every USER_PERMISSION code, what it governs, and where it is enforced in the front end.
- [Event and message catalogue](https://docx.payability.com/internal-admin/reference/event-catalog.html): Domain event types and targets, event-rule actions, the iframe postMessage protocol, and the in-app event bus.
- [Codebase inventory](https://docx.payability.com/internal-admin/reference/inventory.html): Counts and distribution of components, services, models and specs per module — a sense of scale and where the weight sits.

## Morpheus

- [Morpheus](https://docx.payability.com/morpheus/index.html): Automated outbound sales platform for Amazon and Walmart marketplace sellers, built on AWS.
- [System architecture](https://docx.payability.com/morpheus/architecture.html): How the Morpheus deployable units, queues, schedules, and data stores fit together.
- [Repository layout](https://docx.payability.com/morpheus/repository-layout.html): What lives where in the agentcore monorepo.
- [Glossary](https://docx.payability.com/morpheus/glossary.html): Domain and platform terms used throughout the Morpheus documentation.
- [Configuration and secrets](https://docx.payability.com/morpheus/configuration.html): Every environment variable and secret key used by Morpheus, per deployable unit.
- [Local development](https://docx.payability.com/morpheus/development.html): Toolchain, setup, running each unit locally, and the test suites.
- [Deployment](https://docx.payability.com/morpheus/deployment.html): How each Morpheus unit is deployed, in what order, and what to verify afterwards.
- [Operations and runbooks](https://docx.payability.com/morpheus/operations.html): Day-to-day operation of Morpheus — logs, queues, watermarks, kill switches, common failures.
- [Security and data handling](https://docx.payability.com/morpheus/security.html): Credential handling, PII rules, tenant isolation, IAM posture, and the prompt-injection surface.
- [Engineering conventions](https://docx.payability.com/morpheus/conventions.html): The rules that govern changes in this repository, mirroring AGENTS.md.
- [Writing these docs](https://docx.payability.com/morpheus/docs-contributing.html): How this Antora component is structured, consumed, and extended.
- [Business logic](https://docx.payability.com/morpheus/business/index.html): The domain rules Morpheus enforces — what it decides, on what evidence, and why.
- [Outbound funnel](https://docx.payability.com/morpheus/business/funnel.html): The end-to-end lifecycle from a marketplace data row to a booked demo, and which component owns each transition.
- [Seller discovery](https://docx.payability.com/morpheus/business/seller-discovery.html): Which marketplace sellers enter the pipeline, how pagination advances, and how to stop it.
- [Seller enrichment](https://docx.payability.com/morpheus/business/seller-enrichment.html): How Morpheus gathers contact intelligence for a discovered seller and writes it back.
- [Payout-pain score](https://docx.payability.com/morpheus/business/payout-pain-score.html): The eight weighted signals behind sellers.payoutPainScore, and how the score is produced.
- [CRM sync](https://docx.payability.com/morpheus/business/crm-sync.html): How Morpheus data becomes HubSpot records — object mapping, match priority, write-back, and activity logging.
- [Re-engagement segments](https://docx.payability.com/morpheus/business/re-engagement.html): The five segments that put a previously contacted person back on a call list, with each membership rule and priority formula.
- [Daily call lists](https://docx.payability.com/morpheus/business/call-lists.html): How each sales rep's daily call list is assembled, prioritised, and materialised in HubSpot.
- [Follow-up tasks and escalation](https://docx.payability.com/morpheus/business/follow-up-tasks.html): Task creation, HubSpot mirroring, status polling, and the three-stage Slack escalation ladder.
- [Email engagement](https://docx.payability.com/morpheus/business/email-engagement.html): Reply categorisation, engagement events pushed to HubSpot, and how opt-outs propagate.
- [Phone line intelligence](https://docx.payability.com/morpheus/business/phone-intelligence.html): Twilio line-type classification, risk tiers, automatic blocking, and the CRM write-back.
- [Call logging and dispositions](https://docx.payability.com/morpheus/business/call-logging.html): How AI dialer calls and Five9 rep calls are logged to HubSpot, and how dispositions drive decisions.
- [Ownership and round-robin](https://docx.payability.com/morpheus/business/ownership.html): Who a contact is assigned to, when that assignment is overridden, and how round-robin stays fair across concurrent Lambdas.
- [AgentCore runtime](https://docx.payability.com/morpheus/agentcore/index.html): The containerised Strands agent runtime deployed on Amazon Bedrock AgentCore.
- [Runtime architecture](https://docx.payability.com/morpheus/agentcore/architecture.html): Startup sequence, module responsibilities, and the request lifecycle inside the AgentCore container.
- [Invocation contract](https://docx.payability.com/morpheus/agentcore/invocation.html): The request and response shape for the AgentCore runtime, and how to call it.
- [Workflows](https://docx.payability.com/morpheus/agentcore/workflows.html): The workflow registry, BaseWorkflow's multi-step engine, structured output, and how to add one.
- [Providers and agents](https://docx.payability.com/morpheus/agentcore/providers.html): ClaudeAgentService, the pre-wired agent singletons, and how to add one.
- [Tools](https://docx.payability.com/morpheus/agentcore/tools.html): How agent tools are defined, the vended Strands tools, and the MCP integrations.
- [AgentCore Memory](https://docx.payability.com/morpheus/agentcore/memory.html): The three memory strategies, how a session attaches, and what gets retrieved.
- [Configuration](https://docx.payability.com/morpheus/agentcore/configuration.html): load_config(), the secret schema, and the environment variables the runtime reads.
- [Development and container](https://docx.payability.com/morpheus/agentcore/development.html): Running the runtime locally, the Docker image, tests, and the AgentCore CLI configuration.
- [Lambda functions](https://docx.payability.com/morpheus/lambdas/index.html): The five Lambda functions that make up the Morpheus pipeline, and what each owns.
- [Handler and registry pattern](https://docx.payability.com/morpheus/lambdas/handler-pattern.html): The uniform dispatcher, registry, and handler structure shared by all five Lambda functions.
- [Provider pattern](https://docx.payability.com/morpheus/lambdas/provider-pattern.html): The BaseProvider abstraction, the SmartScout implementation in full, and how to add a second seller source.
- [enrichment-scraper](https://docx.payability.com/morpheus/lambdas/enrichment-scraper.html): Seller discovery from SmartScout and the incremental BigQuery contact sync.
- [enrichment-scorer](https://docx.payability.com/morpheus/lambdas/enrichment-scorer.html): Seller persistence, AI enrichment, payout-pain scoring, and CRM publication.
- [morpheus-hubspot](https://docx.payability.com/morpheus/lambdas/morpheus-hubspot.html): The single writer to HubSpot — 12 SQS event types, 9 scheduled handlers.
- [email-agent](https://docx.payability.com/morpheus/lambdas/email-agent.html): Inbound email reply categorisation with Bedrock structured output, and the multi-tenant safety model.
- [phone-agent](https://docx.payability.com/morpheus/lambdas/phone-agent.html): Twilio line intelligence, Slack task reminders and escalation, and campaign re-engagement.
- [Testing Lambdas](https://docx.payability.com/morpheus/lambdas/testing.html): Test layout, the deferred-import pattern that makes handlers testable, and how to invoke locally.
- [Events](https://docx.payability.com/morpheus/events/index.html): How Morpheus components communicate — transports, routing keys, and the event design rules.
- [Event catalog](https://docx.payability.com/morpheus/events/catalog.html): Every event type in Morpheus, with its transport, producer, consumer, and model.
- [CrmSyncQueue events](https://docx.payability.com/morpheus/events/crm-sync-queue.html): The twelve event schemas consumed by morpheus-hubspot from CrmSyncQueue.
- [EnrichmentPipelineQueue events](https://docx.payability.com/morpheus/events/enrichment-pipeline-queue.html): The SellerRecord.Received event that carries a discovered seller into the enrichment pipeline.
- [EmailAgentQueue events](https://docx.payability.com/morpheus/events/email-agent-queue.html): Inbound email events consumed by email-agent, and the one published event with no handler.
- [Scheduled (EventBridge) events](https://docx.payability.com/morpheus/events/scheduled.html): How scheduled triggers carry a routing key, and every detail-type in the platform.
- [HubSpot webhooks](https://docx.payability.com/morpheus/events/hubspot-webhooks.html): How HubSpot-side changes reach Morpheus, and the ordered processor registry that handles them.
- [Publishing events](https://docx.payability.com/morpheus/events/publishing.html): publish_event(), publish_events(), FIFO message groups and deduplication, and the standard-queue publisher.
- [Adding a new event](https://docx.payability.com/morpheus/events/adding-an-event.html): The five steps to add an event type to a Lambda function, with a worked example.
- [Shared libraries](https://docx.payability.com/morpheus/libs/index.html): The five Python libraries under libs/, packaged as Lambda layers.
- [morpheus-common](https://docx.payability.com/morpheus/libs/morpheus-common.html): Event models, the SQS publisher, the cached secrets helper, and Sentry configuration.
- [morpheus-llm](https://docx.payability.com/morpheus/libs/morpheus-llm.html): Strands agent services, Bedrock model configuration, MCP tools, and structured output.
- [morpheus-data-layer](https://docx.payability.com/morpheus/libs/morpheus-data-layer.html): Session management, connection pooling, ORM models, and the repository layer over PostgreSQL.
- [morpheus-bigquery](https://docx.payability.com/morpheus/libs/morpheus-bigquery.html): The BigQuery client factory used by every warehouse-backed handler.
- [pyb-hubspot](https://docx.payability.com/morpheus/libs/pyb-hubspot.html): The HubSpot client and every HubSpot API call in the platform.
- [Data](https://docx.payability.com/morpheus/data/index.html): The two data planes Morpheus reads and writes — PostgreSQL for operations, BigQuery for segmentation.
- [Domain model](https://docx.payability.com/morpheus/data/domain-model.html): The core Morpheus entities, how they relate, and the identity rules that hold them together.
- [ORM models](https://docx.payability.com/morpheus/data/orm-models.html): The 13 SQLAlchemy models, the conventions they follow, and how they map to PostgreSQL enums.
- [Repositories](https://docx.payability.com/morpheus/data/repositories.html): Every repository class in morpheus-data-layer, with method signatures, upsert keys, and transaction semantics.
- [Enumerations](https://docx.payability.com/morpheus/data/enums.html): Every StrEnum in the data layer and the shared libraries, with exact member values.
- [Runtime state in configs](https://docx.payability.com/morpheus/data/configs-table.html): The key/value table that holds every watermark, cursor, and kill switch, and the exact keys in use.
- [BigQuery warehouse](https://docx.payability.com/morpheus/data/warehouse.html): The datasets Morpheus reads, how they get there, the deduplication pattern, and how credentials are supplied.
- [BigQuery views](https://docx.payability.com/morpheus/data/bigquery-views.html): Every view and materialisation in bigquery/, its output columns, and the handler that consumes it.
- [Prisma schema reference](https://docx.payability.com/morpheus/data/prisma-schema.html): The authoritative PostgreSQL schema, which parts Morpheus maps, and where the SQLAlchemy models have drifted from it.
- [Infrastructure](https://docx.payability.com/morpheus/infrastructure/index.html): The two independent infrastructure-as-code stacks, what each owns, and where the boundary sits.
- [CDK stack (AgentCoreStack)](https://docx.payability.com/morpheus/infrastructure/cdk-stack.html): Every construct in the single CDK stack — image asset, AgentCore memory and runtime, roles, log group, outputs.
- [SAM template](https://docx.payability.com/morpheus/infrastructure/sam-template.html): The single template that defines every Lambda function, layer, queue, schedule, and the shared secret.
- [Queues and dead-letter queues](https://docx.payability.com/morpheus/infrastructure/queues.html): The three SQS queues, their FIFO and redrive configuration, and why a failed message goes straight to the DLQ.
- [EventBridge schedules](https://docx.payability.com/morpheus/infrastructure/schedules.html): Every scheduled rule in the SAM template, its expression, its Input payload, and the handler it reaches.
- [Lambda layers](https://docx.payability.com/morpheus/infrastructure/layers.html): The five shared libraries packaged as layers, how they are built, and why their attachment order matters.
- [Secrets Manager](https://docx.payability.com/morpheus/infrastructure/secrets.html): The two secrets, which stack owns each, how they are loaded and cached, and what deploying does not do.
- [IAM](https://docx.payability.com/morpheus/infrastructure/iam.html): The runtime role's inline policies, the SAM-generated function roles, and where the permission model is wide.
- [Observability](https://docx.payability.com/morpheus/infrastructure/observability.html): What the platform actually reports — Sentry, CloudWatch logs, the one alarm — and the gaps in the current setup.
- [Roadmap and plans](https://docx.payability.com/morpheus/plans/index.html): Forward-looking design documents for the agent estate and the BDR motion — intent, not implementation.
- [System Architecture](https://docx.payability.com/morpheus/plans/architecture.html): Planned target architecture for the multi-agent outbound estate. Design intent, not deployed reality.
- [Enrichment Agent](https://docx.payability.com/morpheus/plans/enrichment-agent.html): Original design for seller discovery, contact enrichment, and scoring. Shipped largely as planned.
- [Voice Agent (Retell AI)](https://docx.payability.com/morpheus/plans/voice-agent.html): Proposed autonomous outbound caller on Retell AI. The deployed system supports human reps instead.
- [Email Agent](https://docx.payability.com/morpheus/plans/email-agent.html): Proposed email agent covering sequence generation, sending, and reply handling. Only reply classification shipped.
- [LinkedIn Agent](https://docx.payability.com/morpheus/plans/linkedin-agent.html): Proposed LinkedIn agent for connection requests, InMail, and engagement sequencing. Not built.
- [Content Agent](https://docx.payability.com/morpheus/plans/content-agent.html): Proposed inbound content generation and distribution agent. Not built.
- [Re-engagement reporting](https://docx.payability.com/morpheus/plans/re-engagement-reporting.html): A catalogue of the reports proposed to measure whether the five re-engagement segments actually produce calls, connections, and pipeline.
- [BDR Playbook (3 BDRs + Five9 Parallel Dialer)](https://docx.payability.com/morpheus/plans/bdr-playbook.html): How three BDRs work a Five9 parallel dialer — roles, cadence, qualification, and handoff.
- [Paid Advertising Playbook](https://docx.payability.com/morpheus/plans/paid-ads.html): Proposed paid acquisition playbook running alongside outbound. Not built.

## OPPA

- [OPPA](https://docx.payability.com/oppa/index.html): What OPPA does and where to read next.
- [Architecture](https://docx.payability.com/oppa/architecture.html): Lambdas, Step Functions, and the data OPPA keeps.
- [Local development](https://docx.payability.com/oppa/development.html): Install OPPA with uv and run the local checks.
- [Deployment](https://docx.payability.com/oppa/deployment.html): How the CDK v2 pipeline is updated and how later commits deploy.

## Payability Documentation

- [Using these docs from AI agents](https://docx.payability.com/pyb-docs/ai-agents.html): Connect Claude Code, Cursor or another MCP client to the docs, or point an agent at llms.txt.
- [New Page](https://docx.payability.com/pyb-docs/new-page.html)
- [Payability Documentation](https://docx.payability.com/pyb-docs/index.html): Architecture, business rules, integrations and operating guides for every Payability system, in one place.

## Supplier Client

- [Supplier Client](https://docx.payability.com/supplier-client/index.html): Developer reference for the Payability Supplier Client — an Angular SPA for supplier onboarding, financial products, reporting and account management.
- [Architecture Overview](https://docx.payability.com/supplier-client/architecture/overview.html): Module hierarchy, layering rules, and the cross-cutting patterns used throughout the Supplier Client.
- [Project Layout](https://docx.payability.com/supplier-client/architecture/project-layout.html): Directory-by-directory map of the repository.
- [Bootstrap & Initialization](https://docx.payability.com/supplier-client/architecture/bootstrap.html): What happens between page load and the first rendered route.
- [Application Shell](https://docx.payability.com/supplier-client/architecture/app-shell.html): BaseComponent, the aside and header navigation, the subheader, layout/menu/page config and the splash screen.
- [Forms, Fields and Validation](https://docx.payability.com/supplier-client/architecture/forms-and-fields.html): The dynamic field component, config-driven form construction, the validator set, address data and error-message resolution.
- [Flows & Tasks Engine](https://docx.payability.com/supplier-client/architecture/flows-and-tasks.html): The TasksFlow mini-engine that drives multi-step modal wizards, and the flows built on it.
- [Coding Conventions](https://docx.payability.com/supplier-client/architecture/conventions.html): Naming, structure, and the rules enforced by lint, format and review.
- [Route Tree](https://docx.payability.com/supplier-client/routing/route-tree.html): Every URL the Supplier Client serves, the module behind it, and the guards protecting it.
- [Route Guards](https://docx.payability.com/supplier-client/routing/guards.html): Every guard in the application, what it actually checks, and where it redirects.
- [Authentication](https://docx.payability.com/supplier-client/security/authentication.html): JWT session handling, the login pipeline, AuthService, and the auth NgRX slice.
- [HTTP Interceptors](https://docx.payability.com/supplier-client/security/interceptors.html): The three interceptors registered by CoreModule and how to opt out of them.
- [Two-Factor Authentication](https://docx.payability.com/supplier-client/security/two-factor.html): Authy-backed SMS second factor — setup, enforcement, state and enrolment flow.
- [Permissions System](https://docx.payability.com/supplier-client/security/permissions.html): How the client derives every feature flag from the User object, and the exact condition behind each permission.
- [NgRX Overview](https://docx.payability.com/supplier-client/state/overview.html): Store configuration, the complete slice map, and the conventions every slice follows.
- [Auth Slice](https://docx.payability.com/supplier-client/state/auth-slice.html): Shape, actions, reducers, effects and selectors of the auth feature slice.
- [Feature Slices](https://docx.payability.com/supplier-client/state/feature-slices.html): Every NgRX feature slice — key, purpose, actions and consumers.
- [Entity Slices](https://docx.payability.com/supplier-client/state/entity-slices.html): The @ngrx/entity collections — adapters, id selectors, actions and consumers.
- [State Persistence](https://docx.payability.com/supplier-client/state/persistence.html): How selected store slices survive a page reload, and the pitfalls of the current implementation.
- [Domain Model](https://docx.payability.com/supplier-client/business/domain-model.html): The entities the client reasons about — supplier, status, products, marketplaces — and the fields that drive behaviour.
- [Supplier Lifecycle](https://docx.payability.com/supplier-client/business/supplier-lifecycle.html): How a supplier moves through registration, underwriting, activation, suspension and cancellation — and what changes at each transition.
- [Onboarding](https://docx.payability.com/supplier-client/business/onboarding.html): Schemas, compliance records, the pre-activation status bar, the four onboarding steps, and account activation.
- [DocuSign Contract Flows](https://docx.payability.com/supplier-client/business/docusign.html): All six signing flows, the double replay guard, and what each flow does on return.
- [Advance Line](https://docx.payability.com/supplier-client/business/advance-line.html): The revolving credit product — state, permissions, offer acceptance, withdrawal, expiry and rejection.
- [Instant Advance](https://docx.payability.com/supplier-client/business/instant-advance.html): The fixed-amount advance product, its mutual exclusion with the Advance Line, and repayment tracking.
- [Long Term Contract](https://docx.payability.com/supplier-client/business/long-term-contract.html): The LTC product — new contracts, renewals, contract changes, and the flows that drive them.
- [Instant Transfer](https://docx.payability.com/supplier-client/business/instant-transfer.html): Push-to-card payouts — eligibility, the TabaPay setup flow, fee calculation and error handling.
- [Seller Card](https://docx.payability.com/supplier-client/business/seller-card.html): The prepaid business card — eligibility, the Marqeta-to-Airwallex transition, the unified card model, and every card operation.
- [Vendor Pay](https://docx.payability.com/supplier-client/business/vendor-pay.html): Forward payments — sending money to vendors, and the incoming/outgoing payment reports.
- [Marketplaces & Compliance](https://docx.payability.com/supplier-client/business/marketplaces.html): Supported sales channels, their fixed identifiers, the compliance key system, and connection health.
- [Dashboard Notifications & CTAs](https://docx.payability.com/supplier-client/business/dashboard-notifications.html): The server-driven notification system that powers dashboard CTA cards and auto-opened modals.
- [Cancellation & Reactivation](https://docx.payability.com/supplier-client/business/cancellation.html): Deactivating an account, the cancellation survey, the marketplace opt-out banners, and reactivation.
- [Suspension](https://docx.payability.com/supplier-client/business/suspension.html): Suspension reasons, the reason-to-copy resolution rules, and the remediation modal.
- [Feature Pages Overview](https://docx.payability.com/supplier-client/features/overview.html): Every lazy-loaded page, its route, its gating, and where it is documented in depth.
- [Auth Pages](https://docx.payability.com/supplier-client/features/auth-pages.html): The unauthenticated screens — login, registration, password recovery, new password and staff impersonation.
- [Onboarding Pages](https://docx.payability.com/supplier-client/features/onboarding-pages.html): The /onboarding route tree — status top bar, product offering, repayment information, sign agreement, underwriting review and the loading dialog.
- [Dashboard](https://docx.payability.com/supplier-client/features/dashboard.html): The landing page — which widgets appear, what gates them, and what the page loads.
- [Manage Account](https://docx.payability.com/supplier-client/features/manage-account.html): Account settings — personal and business information, transfer setup, security, and the cancellation workflow.
- [Reports](https://docx.payability.com/supplier-client/features/reports.html): The reporting suite — every report, the shared AG Grid infrastructure, filtering, pagination and export.
- [Seller Card Pages](https://docx.payability.com/supplier-client/features/seller-card-pages.html): The /seller-card list page and the /newcard ordering funnel.
- [My Marketplaces](https://docx.payability.com/supplier-client/features/my-marketplaces.html): Managing connected sales channels — connection status, adding channels, and reconnection.
- [Product Offerings](https://docx.payability.com/supplier-client/features/product-offerings.html): The cross-sell page — which products are offered, how availability is resolved, and how sign-up is routed.
- [Other Pages](https://docx.payability.com/supplier-client/features/other-pages.html): Partners, Referral, PayShield, Blog, Sales Call Summary, Send Money and Help Center.
- [Integrations Overview](https://docx.payability.com/supplier-client/integrations/overview.html): Every third-party service the client talks to, what it is used for, and where it is configured.
- [API Client](https://docx.payability.com/supplier-client/integrations/api-client.html): How the client talks to the backend — the generated pyb-ng2-api package, the six base URLs, EnvironmentService, and the cases that bypass the client.
- [Marketplace API Connectors](https://docx.payability.com/supplier-client/integrations/marketplace-connectors.html): Continuous connection-health monitoring for Amazon and Shopify, with reconnect banners and guided modals.
- [Plaid](https://docx.payability.com/supplier-client/integrations/plaid.html): Bank account linking — module configuration, the OAuth redirect dance, and the notifications that trigger it.
- [Marqeta & Airwallex](https://docx.payability.com/supplier-client/integrations/card-issuers.html): The two card issuers, how they differ, and how the client keeps them behind one interface.
- [Entrust Identity](https://docx.payability.com/supplier-client/integrations/entrust.html): Identity verification and re-verification through Entrust, rendered with the Onfido SDK.
- [reCAPTCHA](https://docx.payability.com/supplier-client/integrations/recaptcha.html): Invisible reCAPTCHA v3 on the authentication forms.
- [Observability](https://docx.payability.com/supplier-client/integrations/observability.html): CloudWatch metrics, page-load timing, session replay, and error surfacing.
- [Event Logger](https://docx.payability.com/supplier-client/analytics/event-logger.html): EventLoggerService, the Segment wiring, user identification, and how to add an event.
- [Event Catalog](https://docx.payability.com/supplier-client/analytics/event-catalog.html): Every Segment event the client emits, its constant, its properties, and where it fires.
- [Service Catalog](https://docx.payability.com/supplier-client/reference/services.html): Every service in core/pyb/services and the notable feature-scoped services, with what they do.
- [Enum Reference](https://docx.payability.com/supplier-client/reference/enums.html): Every domain enum, its values, and where it is used.
- [Model Reference](https://docx.payability.com/supplier-client/reference/models.html): Client-side domain models, their fields, and the DTO mappers that build them.
- [Shared Components](https://docx.payability.com/supplier-client/reference/components.html): Complete inventory of shared widgets, modals, UI primitives, grid cells and shell components.
- [Utility Reference](https://docx.payability.com/supplier-client/reference/utilities.html): Shared helper functions, base classes, pipes, directives, constants and animations.
- [Path Aliases](https://docx.payability.com/supplier-client/reference/path-aliases.html): The TypeScript path aliases, what they resolve to, and the one that resolves to two directories.
- [Glossary](https://docx.payability.com/supplier-client/reference/glossary.html): Domain terms, abbreviations, and the code identifiers behind them.
- [Local Setup](https://docx.payability.com/supplier-client/development/setup.html): Getting the application running against a backend environment.
- [Build & Release](https://docx.payability.com/supplier-client/development/build-and-release.html): Build targets, the CodeBuild pipeline, the service worker, and how versions are stamped.
- [Testing](https://docx.payability.com/supplier-client/development/testing.html): Unit tests with Karma and Jasmine, shared mocks, and the Cypress end-to-end suite.
- [Internationalization](https://docx.payability.com/supplier-client/development/i18n.html): How translations are loaded, where keys live, and the rules for adding copy.
- [Styling and Theming](https://docx.payability.com/supplier-client/development/styling-and-theming.html): The SCSS layer cake, runtime theme switching, dark mode, white-label providers, and the icon registry.
- [Progressive Web App](https://docx.payability.com/supplier-client/development/pwa.html): Service worker registration and caching, the update banner, offline detection, and the iOS install prompt.
- [Adding a Feature](https://docx.payability.com/supplier-client/development/adding-a-feature.html): End-to-end checklist for shipping a new page, a new permission, a new event or a new DocuSign flow.