Getting Started

Prerequisites

Required:

1. Your 8x8 tenant name
2. API credentials - See Authentication for details
   • Recommended: Admin Console Keys from 8x8 Admin Console (X-API-Key format)
   • Also supported: Contact Center (CC) Tokens from Configuration Manager
3. A WebSocket client - Use provided examples or your own implementation

Quick Start with Example Clients

Use one of the pre-built client examples:

📘 Authentication

The examples below use --x-api-key which works for both Admin Console Keys (recommended) and CC Tokens (also supported). See the Authentication Guide for details on obtaining credentials.

Go

See the Go Client Example for complete code and build instructions.

Java

See the Java Client Example for complete code and Maven configuration.

Python

See the Python Client Example for complete code and dependencies.

Node.js

See the Node.js Client Example for complete code and package.json.

Browser

Access the Pulsar UI web service - no installation required.

What You'll See

Events are delivered in JSON format:

{
  "eventId": "evt_123456",
  "eventType": "agent.login",
  "timestamp": "2025-10-15T09:30:00Z",
  "tenantId": "your-tenant",
  "data": {
    "agentId": "12345",
    "extensionId": "67890"
  }
}

Processing Events

Pipe output to tools like jq for filtering and processing:

# Pretty-print all events
./pulsar-simple-client -tenant YOUR_TENANT -x-api-key YOUR_KEY | jq .

# Filter only agent login events
./pulsar-simple-client -tenant YOUR_TENANT -x-api-key YOUR_KEY | \
  jq 'select(.eventType == "agent.login")'

# Extract specific fields
./pulsar-simple-client -tenant YOUR_TENANT -x-api-key YOUR_KEY | \
  jq '{eventType: .eventType, timestamp: .timestamp}'

Connection Parameters

The quick start client requires your tenant name and API key. The service connects to:

• Host: Regional endpoint (e.g., pulsar-ws-euw2.8x8.com for UK3) - see Regional Endpoints
• Namespace: event-v1
• Topic: all (receives all event types)

For complete connection details including all available topics, query parameters, and URL construction, see the Connection Guide.

Next Steps

• Connection details - WebSocket connection details
• Authentication options - Authentication methods
• Message format - Event structure
• Code examples - Complete working examples
• Troubleshooting - Common issues

Need Help?

For issues:

1. See Troubleshooting Guide
2. Review the complete code examples in the language-specific guides above
3. Contact 8x8 support for credentials or access issues