Automations overview
How to manage the bridge between Synap and external automation tools (n8n, ActivePieces, Make, or your own apps). Even if flows run elsewhere, Synap gives you one place to control access and see what’s possible.Generate and manage API keys
In the Synap app, go to Settings → API Access. Create an API key with the scopes you need: hub-protocol.read for search and reading context, hub-protocol.write for creating and updating entities and documents. Keys are scoped to your user and workspace. Rotate keys periodically; revoking a key invalidates it immediately (existing tokens may still be valid until they expire).
Webhook subscriptions (incoming events)
When we support outbound webhooks, you’ll register a URL (e.g. your n8n webhook node) and choose which events to receive (e.g. entity created, document updated). Until then, you can trigger automations from inside Synap or by polling the API from n8n/Make on a schedule. The n8n guide describes the pattern with a webhook URL you expose from n8n.
→ n8n integration guideEvent logs and traceability
All entity and document changes go through an event chain (requested → validated → completed). In the future, an Automations surface in Synap will show delivery logs for webhooks, retries, and which workflow or key performed an action. This gives you a clear audit trail: “This task was created by API key X” or “This update came from n8n run #123.”
Test your requests
Use the examples in the API Quickstart with curl or Postman. Send a POST to /api/hub/entities with your base URL and Bearer token. You should get back { status, message, id }. If you get 401, check your API key and scopes; if you get 400, ensure userId, workspaceId, type, and title are present. A future “Send test event” UI in Settings will let you pick an event type and see the exact JSON payload and delivery result.
