# Harly

## Docs

- [Introduction](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/introduction.md): Harly is an open-source applicant tracking system for modern teams.
- [Quickstart](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/quickstart.md): Install Harly on a fresh VPS with the guided CLI in under 15 minutes.
- [Create your first workspace](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/getting-started/first-workspace.md): Set up the team, roles, pipeline, career page, and first job after Harly bootstrap.
- [Daily recruiting workflow](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/getting-started/daily-workflow.md): A practical operating guide for reviewing candidates, collaborating, scheduling, and closing a hire.
- [Tutorial: your first hire](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/tutorials/first-hire.md): End-to-end walkthrough — open a job, collect applications, run interviews, send an offer, and close the hire.
- [Tutorial: set up integrations](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/tutorials/setup-integrations.md): Connect Google Calendar, email, Slack notifications, and Harly Sign in a single session.
- [Tutorial: build an API integration](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/tutorials/api-integration.md): Create a scoped API key, call the Harly REST API, verify webhook signatures, and handle retries safely.
- [Using Harly](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/product/overview.md): How jobs, candidates, interviews, offers, and the candidate portal connect into one recruiting workflow.
- [Jobs](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/product/jobs.md): Create roles, build their pipeline and application form, assign a hiring team, and publish.
- [Candidates and pipeline](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/product/candidates-and-pipeline.md): Review candidate records, move applications through stages, and reject or hire with a clear reason.
- [Interviews and scheduling](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/product/interviews-and-scheduling.md): Schedule interviews with calendars and video, run structured scorecards, and recover from provider outages.
- [Offers and signatures](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/product/offers-and-signatures.md): Generate an offer, send it with Harly Sign or DocuSeal, and confirm the accepted state before you close a hire.
- [Inbox and email](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/product/inbox-and-email.md): Configure candidate email, send from a record, triage replies, and work a shared inbox.
- [Tasks and scorecards](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/product/tasks-and-scorecards.md): Assign follow-up work to the hiring team and collect structured interview feedback.
- [Documents](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/product/documents.md): Request documents from candidates, collect them in the portal, and apply retention and expiry rules.
- [Career page](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/product/career-page.md): Publish your public job board, brand it, embed it, and control which jobs appear.
- [Candidate portal](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/product/candidate-portal.md): Give candidates a secure place to track applications, upload documents, sign in with magic link or OAuth, and manage their data.
- [Reports and analytics](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/product/reports-and-analytics.md): Measure pipeline health, hiring velocity, source effectiveness, and where candidates drop off.
- [AI features](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/product/ai-features.md): Optional, provider-backed assistance for matching, drafting, and anonymized review — always advisory.
- [Self-hosting overview](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/self-hosting/overview.md): VPS requirements, memory profiles, and DNS setup for a supported Harly deployment.
- [Proxy modes](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/self-hosting/proxy-modes.md): Compare Caddy, external reverse proxy, and local-only modes for self-hosted Harly, and trust upstream proxies for correct client IPs.
- [Deploy with the Harly CLI](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/deployment/cli.md): Install, deploy, operate, and automate self-hosted Harly with @harly/cli v0.4.0.
- [Managed cloud deployments](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/deployment/cloud.md): Deploy Harly on Render, DigitalOcean, Railway, or Fly.io with durable storage and a scheduler.
- [Configuration reference](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/deployment/configuration.md): Reference for Harly environment variables: required secrets, storage, scheduler, resource profiles, integrations, and security-sensitive settings.
- [Integrations overview](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/integrations/overview.md): Understand installation credentials, workspace connections, sync behavior, and provider recovery in Harly.
- [JOIN.com candidate import](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/integrations/join.md): Import candidate applications from JOIN.com into a Harly job with a one-time API token.
- [Greenhouse candidate import](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/integrations/greenhouse.md): Import Greenhouse candidates into a Harly job with a read-only Harvest API key.
- [Workable candidate import](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/integrations/workable.md): Import Workable candidate profiles into a Harly job with the Workable SPI API.
- [Ashby candidate import](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/integrations/ashby.md): Import Ashby candidate profiles into a Harly job with an Ashby API key.
- [Lever candidate import](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/integrations/lever.md): Import Lever opportunities and candidate profiles into a Harly job with a Lever API key.
- [Email, inbound replies, and mailboxes](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/integrations/email.md): Configure outbound email with Resend or SMTP, and route candidate replies back to the application record.
- [Google Calendar and Google Meet](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/integrations/google-calendar.md): Configure Google OAuth once on the server, then connect a workspace calendar from Harly.
- [Microsoft Outlook and Teams](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/integrations/microsoft.md): Configure Microsoft Entra OAuth for Outlook calendars and Teams interview meetings.
- [Video interview providers](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/integrations/video.md): Configure Zoom, Microsoft Teams, Google Meet, or Jitsi and verify the generated interview link.
- [Slack, Discord, and Telegram notifications](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/integrations/notifications.md): Send recruiting notifications to team channels while keeping secrets and delivery retries controlled.
- [E-signatures and offer signing](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/integrations/signatures.md): Configure Harly Sign or DocuSeal, send signature requests, and verify signed offer state safely.
- [File storage](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/integrations/storage.md): Choose local volume storage or S3-compatible storage for resumes, documents, and attachments.
- [Access control and workspace security](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/security/access-control.md): Create least-privilege roles, assign workspace members, apply job scopes, enforce MFA and IP allowlists, and review audit events in Harly.
- [SSO and SCIM provisioning](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/security/sso-scim.md): Connect your identity provider for single sign-on and automate member provisioning with SCIM 2.0.
- [Privacy and data retention](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/security/privacy.md): Configure retention, handle data-subject requests, manage consent records, and operate AI features responsibly.
- [API overview](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/developers/api-overview.md): Build integrations against Harly's versioned REST API with scoped keys, pagination, idempotency, and safe retries.
- [API resource reference](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/developers/api-reference.md): Inventory of Harly REST resources, scopes, mutation semantics, and error statuses.
- [Webhooks](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/developers/webhooks.md): Subscribe to Harly domain events, verify signatures, handle retries, and replay failed deliveries.
- [Realtime updates](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/developers/realtime.md): Consume Harly's server-sent events stream for live workspace updates without page refreshes.
- [Automations](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/developers/automations.md): Build safe recruiting automations with triggers, conditions, actions, retries, and human approval points.
- [List jobs](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/jobs/list-jobs.md): Retrieve a cursor-paginated list of jobs for the workspace.
- [Create job](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/jobs/create-job.md): Create a new job posting in the workspace.
- [Get job](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/jobs/get-job.md): Retrieve details of a single job by its ID.
- [Delete job](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/jobs/delete-job.md): Soft-delete a job. Reverts its status to closed.
- [Update job](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/jobs/update-job.md): Update fields of an existing job.
- [Publish job](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/jobs/publish-job.md): Set job status to open and set publishedAt timestamp.
- [Close job](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/jobs/close-job.md): Set job status to closed.
- [List job stages](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/jobs/list-job-stages.md): List the ordered pipeline stages for a job.
- [Update job stage](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/jobs/update-job-stage.md): Edit a single pipeline stage in a job.
- [List candidates](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/candidates/list-candidates.md)
- [Create candidate](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/candidates/create-candidate.md)
- [Get candidate](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/candidates/get-candidate.md)
- [Delete candidate](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/candidates/delete-candidate.md)
- [Update candidate](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/candidates/update-candidate.md)
- [List candidate notes](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/candidates/list-candidate-notes.md)
- [Create candidate note](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/candidates/create-candidate-note.md)
- [List candidate tags](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/candidates/list-candidate-tags.md)
- [Create candidate tag](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/candidates/create-candidate-tag.md)
- [Delete candidate tag](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/candidates/delete-candidate-tag.md)
- [List candidate files](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/candidates/list-candidate-files.md)
- [List applications](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/applications/list-applications.md)
- [Create application](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/applications/create-application.md)
- [Get application](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/applications/get-application.md)
- [Move application](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/applications/move-application.md)
- [Reject application](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/applications/reject-application.md)
- [Hire application](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/applications/hire-application.md)
- [Bulk create applications](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/applications/bulk-create-applications.md)
- [List API keys](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/api-keys/list-api-keys.md)
- [Create API key](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/api-keys/create-api-key.md)
- [Delete API key](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/api-keys/delete-api-key.md)
- [Rotate API key](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/api-keys/rotate-api-key.md)
- [List webhooks](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/webhooks/list-webhooks.md)
- [Create webhook](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/webhooks/create-webhook.md)
- [Delete webhook](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/webhooks/delete-webhook.md)
- [Update webhook](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/webhooks/update-webhook.md)
- [Test webhook](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/webhooks/test-webhook.md)
- [List webhook deliveries](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/webhooks/list-webhook-deliveries.md)
- [Replay webhook delivery](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/webhooks/replay-webhook-delivery.md)
- [List webhook delivery attempts](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/webhooks/list-webhook-delivery-attempts.md)
- [List interviews](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/interviews/list-interviews.md)
- [Create interview](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/interviews/create-interview.md)
- [Get interview](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/interviews/get-interview.md)
- [Update interview](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/interviews/update-interview.md)
- [Cancel interview](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/interviews/cancel-interview.md)
- [Complete interview](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/interviews/complete-interview.md)
- [List offers](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/offers/list-offers.md)
- [Create offer](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/offers/create-offer.md)
- [Get offer](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/offers/get-offer.md)
- [Update offer](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/offers/update-offer.md)
- [Send offer](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/offers/send-offer.md)
- [Decide offer](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/offers/decide-offer.md)
- [Withdraw offer](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/offers/withdraw-offer.md)
- [List scorecards](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/scorecards/list-scorecards.md)
- [Create scorecard](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/scorecards/create-scorecard.md)
- [List tasks](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/tasks/list-tasks.md)
- [Create task](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/tasks/create-task.md)
- [Get task](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/tasks/get-task.md)
- [Delete task](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/tasks/delete-task.md)
- [Update task](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/tasks/update-task.md)
- [List activity events](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/activity/list-activity-events.md)
- [List pool entries](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/pool/list-pool-entries.md)
- [Create pool entry](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/pool/create-pool-entry.md)
- [Remove pool entry](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/pool/remove-pool-entry.md)
- [Assign pool entry](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/pool/assign-pool-entry.md)
- [Get current API key context](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/auth/get-current-api-key-context.md)
- [List automations](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/automations/list-automations.md)
- [Create automation](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/automations/create-automation.md)
- [Get automation](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/automations/get-automation.md)
- [Delete automation](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/automations/delete-automation.md)
- [Update automation](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/automations/update-automation.md)
- [List automation runs](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/automations/list-automation-runs.md)
- [Retry automation run](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/automations/retry-automation-run.md)
- [Cancel automation run](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/api-reference/automations/cancel-automation-run.md)
- [Operations](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/self-hosting/operations.md): Health checks, the scheduler, backups, restore, and upgrades for a Harly installation.
- [Backups and restore](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/operations/backups.md): Create rollback archives, protect production data off-host, and verify restores with a throwaway installation.
- [Troubleshooting](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/operations/troubleshooting.md): Diagnose installation, proxy, scheduler, email, integrations, API, and realtime failures.
- [Screenshots and visual evidence](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/operations/screenshots.md): Capture useful, privacy-safe screenshots for support, runbooks, and documentation.

## OpenAPI Specs

- [openapi](https://vytral-dependabot-npm-and-yarn-development-95cc887cce.mintlify.site/openapi.json)