Documentation

Guides, API references, and integration patterns for everything SecureTransmit does.

Docs in progress. We're fleshing these out alongside the public launch. The structure below mirrors what's shipping. Pages marked Stub are placeholders. Looking for something specific? Ask us and we'll prioritize it.

Getting started

  • Quick start Stub Move your first file through SecureTransmit in under 10 minutes.
  • Core concepts Stub Ingress, workflows, egress, canonical URLs, audit, how the pieces fit.
  • Authentication & API keys Stub Create, rotate, and scope API keys.

Ingress

  • SFTP uploads Stub Evented, filesystem-less SFTP that triggers workflows on PUT / GET.
  • HTTPS API ingest Stub Send files and payloads directly to SecureTransmit over HTTPS.
  • Industrial webhook receive Stub Register SecureTransmit as your public webhook endpoint. Signed, typed events.
  • Secure webforms Stub Accept files and structured data from anyone, safely.

Workflow engine

  • Workflow basics Stub Event-driven transforms, routing, validation, retries, replay.
  • Format transforms Stub CSV, XML, JSON, EDI (X12 / EDIFACT / custom) in any direction.
  • AI enrichment (BYO token) Stub Classify, extract, summarize, translate, with your provider, your API key.
  • Conditional routing Stub Route by payload contents, sender, file type, or workflow state.
  • Retries & replay Stub Automatic retry policies, manual replay, dead-letter handling.

Egress & reference

  • API calls Stub Call downstream APIs with auth, retries, and full audit.
  • SFTP push Stub Deliver files to partner SFTP endpoints with key management.
  • Industrial webhook send Stub Stripe-grade reliability: signing, retries, replay on the consumer side.
  • Canonical URLs Stub Stable, redirectable references. Swap backends without breaking clients.
  • Email delivery Stub Notifications and data delivery via email.

Security architecture

  • Standard mode Stub AES-256 at rest, TLS in transit, least privilege, full audit.
  • Sealed mode Stub Pre-encrypted payloads that SecureTransmit moves but never decrypts.
  • Paranoid mode (ephemeral) Stub Delete-on-ack. SHA-256 hash and audit kept forever for non-repudiation.
  • Island mode (outbound-only) Stub Close every inbound B2B port. Partners push to SecureTransmit, you pull.
  • Built-in firewall Stub IP allow / deny, credential-level rules, country-code blocking.

API reference

  • API overview Stub REST API for workflows, transfers, canonical URLs, and audit queries.
  • Webhooks reference Stub Event types, signing, replay, and delivery guarantees.
  • Audit log schema Stub Immutable, hash-verified records, what's stored and how to query.

Operations

  • Team, seats, and roles Stub Invite teammates, set roles, manage access.
  • Custom domains Stub Bring your own domain for SFTP, webhooks, and canonical URLs.
  • Monitoring & alerts Stub Real-time status, alerts on failure, delivery metrics.

Can't find your answer here?

The docs are still filling in. If you have a question about anything on the site, ask us directly, we'd rather answer it than have you guess.

Ask a question