Getting Started

PrivacyFlow relays encrypted messages between your customers on Signal, SimpleX, and Session and the automation stack you run — poll-based, API-key auth.

PrivacyFlow relays encrypted messages between your customers on Signal, SimpleX, and Session and the automation stack you already run — n8n, an AI agent, or any HTTP client. You never touch a phone; the API does the encryption and delivery.

This is the developer surface. Send and receive in minutes, scale to thousands of conversations, all poll-based over HTTPS with API-key auth.

Who these docs are for

• Builders wiring PrivacyFlow into n8n, a custom workflow, or an AI agent.
• Operators managing apps, credentials, billing, and message routing in the dashboard.
• Anyone who wants to verify, poll, or send against https://privacyflow.app with a single API key.

What you need before you start

1. A PrivacyFlow account. Add PrivacyFlow as a contact in Signal, SimpleX, or Session and send /signin. The dashboard issues your API key.
2. An appId — the unique identifier for one of your messaging apps. Your key lists the appIds it can access via GET /api/v1/auth/verify.
3. The recipient’s contactId in the right format for their messenger. See contact formats.

Where to go next

• Quickstart — verify, poll, and send a real encrypted message in five minutes.
• Concepts — appId, contactId, credential types, and the poll-only delivery model.
• Authentication — the three header methods and which credential type allows which.
• API Reference — every endpoint, schema, status code, and rate limit.
• Clients — install the MCP server, the Agent Zero channel, or the n8n node.