Getting Started
Quickstart Guide
Get your first OllaSync workspace running in under five minutes. Install the SDK, authenticate, and send your first message.
1Install the SDK
OllaSync publishes first-party SDKs for JavaScript, Python, and Go. Start with the JavaScript SDK — it works in Node.js, Deno, and the browser.
Terminal
npm install @ollasync/sdkOr with yarn: yarn add @ollasync/sdk
2Authenticate
Create an API key in your workspace settings, then initialize the client. Keys are scoped to workspaces and support fine-grained permissions.
index.ts
import { OllaSync } from '@ollasync/sdk';
const olla = new OllaSync({
apiKey: process.env.OLLASYNC_API_KEY,
workspace: 'my-team',
});Never commit API keys
Always load keys from environment variables. Use .env locally and your CI's secrets in production.
3Send a message
Your workspace is live. Use the Messages API to post to any channel — threads, reactions, and rich text are all supported.
send-message.ts
const message = await olla.messages.send({
channel: '#engineering',
text: 'Deploy shipped 🚀',
metadata: { priority: 'high' },
});
console.log(message.id); // "msg_abc123"Response
JSON
{
"id": "msg_abc123",
"channel": "#engineering",
"text": "Deploy shipped 🚀",
"author": "usr_xyz789",
"created_at": "2024-12-12T14:32:01Z"
}