API Reference

curl -X GET "https://api.orbinto.com/v1/conversations" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

{
  "data": [
    {
      "id": "conv_abc123",
      "status": "open",
      "visitor": {
        "name": "Jane Doe",
        "email": "jane@example.com"
      },
      "assigned_to": "op_xyz789",
      "created_at": "2026-02-11T10:30:00Z",
      "updated_at": "2026-02-11T10:35:22Z",
      "messages_count": 5
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 25,
    "total": 142,
    "has_more": true
  }
}

# Redirect user to Orbinto authorization page
https://app.orbinto.com/oauth/authorize?
  client_id=YOUR_CLIENT_ID&
  redirect_uri=https://yourapp.com/callback&
  response_type=code&
  scope=contacts:read conversations:read conversations:write

HTTP/1.1 200 OK
X-RateLimit-Limit: 500
X-RateLimit-Remaining: 487
X-RateLimit-Reset: 1707654000
Retry-After: 30            # Only present on 429 responses

{
  "event": "message.created",
  "timestamp": "2026-02-11T10:35:22Z",
  "data": {
    "id": "msg_def456",
    "conversation_id": "conv_abc123",
    "type": "visitor",
    "body": "Hi, I need help with my order",
    "visitor": {
      "id": "vis_ghi789",
      "name": "Jane Doe",
      "email": "jane@example.com"
    },
    "created_at": "2026-02-11T10:35:22Z"
  }
}

const crypto = require("crypto");

function verifyWebhook(payload, signature, secret) {
  const expected = crypto
    .createHmac("sha256", secret)
    .update(payload)
    .digest("hex");

  return crypto.timingSafeEqual(
    Buffer.from(signature),
    Buffer.from(expected)
  );
}

// In your webhook handler:
const isValid = verifyWebhook(
  req.body,
  req.headers["x-orbinto-signature"],
  "your_webhook_secret"
);

{
  "error": {
    "type": "validation_error",
    "code": "invalid_parameter",
    "message": "The 'email' field must be a valid email address.",
    "param": "email",
    "status": 422,
    "request_id": "req_abc123def456"
  }
}