Quick Start

Get up and running with Oryn in under five minutes.

Create an Account

Sign up at app.oryn.com to get access to the dashboard. You will receive your organization ID and can start configuring channels immediately.

bash

# Sign up via API
curl -X POST https://api.oryn.com/v1/auth/signup \
  -H "Content-Type: application/json" \
  -d '{
    "email": "you@company.com",
    "password": "your-secure-password",
    "organization_name": "Acme Inc"
  }'

Get Your API Key

Navigate to Settings → API Keys in the dashboard and create a new key. Your key will start with ws_live_ for production or ws_test_ for sandbox.

bash

# Verify your API key
curl https://api.oryn.com/v1/me \
  -H "Authorization: Bearer ws_live_YOUR_API_KEY"

Send Your First Message

Use the conversations endpoint to send a text message. Replace {id} with a conversation ID from your dashboard.

bash

curl -X POST https://api.oryn.com/v1/conversations/{id}/messages \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"type": "text", "content": {"text": "Hello from Oryn!"}}'

Set Up Webhooks

Configure a webhook URL in Settings → Webhooks to receive real-time notifications about incoming messages, status updates, and more.

bash

curl -X POST https://api.oryn.com/v1/webhooks \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://your-server.com/webhooks/oryn",
    "events": ["message.received", "message.status_updated"]
  }'

Next steps: Explore the full API reference or install one of our official SDKs to get started faster.