Skip to content

Tryx Documentation

Build WhatsApp Automations With Rust Speed and Python Ergonomics

Tryx combines a Rust runtime core with a typed Python API so you can ship robust bots, integrations, and event-driven workflows without sacrificing performance.

Async-first Typed stubs (.pyi) PyO3 bindings Event-driven architecture

Documentation Mode

This site is designed as a full path: setup -> architecture -> API namespaces -> tutorials -> production operations.

What You Can Do

Messaging

Send text, photo, audio, document, video, GIF, and sticker content with a clean Python API.

Realtime Events

Subscribe to rich event classes for messages, contact updates, sync actions, and lifecycle changes.

Namespace Clients

Use dedicated namespaces for contacts, groups, newsletter, status, privacy, polls, presence, and more.

Typed Development

Use complete Python stubs for editor intelligence, static checks, and better API discoverability.

Choose Your Path

  1. Installation
  2. Quick Start
  3. Authentication Flow
  4. Client API Gateway
  1. Client Namespaces
  2. Events API
  3. Types API
  4. Tutorials
  1. Deployment Guide
  2. Reliability
  3. Troubleshooting
  4. Security
  1. Start with Installation.
  2. Follow Quick Start to build your first running client.
  3. Understand pairing in Authentication Flow.
  4. Learn internals in Architecture and Event Model.
  5. Jump into Client API Gateway and namespace deep dives.
  6. Use Tutorials for implementation patterns.
  7. Use QnA and Troubleshooting when debugging.
  8. Finish with Deployment and Reliability before production.

Project Scope

This documentation set focuses on the Python SDK experience first:

  • Runtime setup and client lifecycle
  • Event payload model and handler patterns
  • API reference for client/events/types/helpers/wacore
  • Performance, reliability, and security operations
  • Practical tutorials and real-world QnA

Rust-internal details remain visible where they directly affect Python usage and behavior.

Quick Technical Index

Client Namespace Gateway

All namespace clients mapped with deep-dive pages.

Operational Readiness

Deployment, reliability, performance, security, and troubleshooting.

Typed Contracts

Shared value objects and type-first usage patterns.

QnA

Scenario-driven answers for practical problems.