Product guide
From intent to evidence.
A practical guide to setting up, operating, and extending Veractly.
Connect your first workflow
Your first sign-in prepares a default workspace, project, and sandbox in Observe mode. Review them in Getting started, then connect an account, test its credentials, and review which operations are qualified. Create a scoped service account and key for your integration. Getting started reports the setup status from your backend.
Open setupIntegrate where actions happen
Use the Python or TypeScript SDK, a framework adapter, MCP, or the HTTP API to attach transaction identity and intent to your workflow. Your deployed API schema is authoritative for supported templates and payloads. Use a stable external transaction key for the business action and an Idempotency-Key for each command. Retry an uncertain command with its original key and unchanged payload.
Create a transaction draftChoose your execution mode
Observe records and checks what happened while your workflow executes. Guard applies authorization and policy checks before an action. Commit lets the runtime execute qualified operations. An environment’s mode ceiling and activation gates constrain what is available. Verification status describes the observed outcome, independently of command acceptance.
Manage environmentsConnect the systems you use
The core operation set covers Stripe refunds and subscription cancellation, mapped Salesforce account state, and PostgreSQL entitlements. Support is operation-specific. Account connection alone does not qualify every action a provider supports. Custom connectors use versioned bundles, conformance reports, qualification, and controlled promotion; customer workers connect systems in your infrastructure.
Manage connectorsFollow the evidence
Open a transaction to inspect its effects, timeline, evidence, and available actions. A successful request or accepted command is not proof that the external outcome occurred. Unresolved or contradictory evidence stays visible. Recovery actions must satisfy the current policy, version, and approval requirements.
Open transactionsInvestigate, recover, and replay
Use incidents to coordinate ownership and investigation. Review proposed repairs before authorizing them. Replays and simulations help inspect behavior under pinned versions and scenarios; simulation results have an explicit fidelity and do not establish that a production action happened.
Open incidentsMake access intentional
Veractly uses WorkOS authentication and backend-enforced organization, project, and environment permissions. Scope service accounts and keys to their task, review human approvals, and inspect support access grants and audit records. Secrets are shown only when issued. Your deployment configuration determines session mode, retention, and infrastructure controls; this guide is not a compliance certification.
Review workspace settings