API Reference

Welcome to the Eventara API documentation. This section provides detailed information about all available REST API endpoints.

Base URL

http://localhost:8080

For production deployments, replace with your actual domain.

Authentication

Current State: No authentication is implemented in the current version.

Production Recommendation: Implement JWT or OAuth2 authentication before deploying to production.

Content Type

All API requests and responses use JSON format:

Content-Type: application/json

Response Format

Success Response

{
  "status": "accepted",
  "eventId": "evt_a1b2c3d4",
  "message": "Event accepted for processing"
}

Error Response

{
  "status": "error",
  "message": "Validation failed",
  "errors": {
    "eventType": "eventType is required (e.g., 'payment.failed')",
    "source": "source is required (e.g:, 'payment-service')"
  }
}

API Sections

• Event Ingestion API - Create and query events
• Metrics API - Retrieve analytics data
• Alert Rules API - Manage alert rules
• Rule Testing API - Test rules before activation

Common HTTP Status Codes

Rate Limiting

Current State: No rate limiting is implemented.

Production Recommendation: Implement rate limiting to prevent abuse (e.g., 1000 requests per minute per IP).

Interactive Documentation

Swagger UI is available for interactive API exploration:

http://localhost:8080/swagger-ui.html

This provides a web interface to test endpoints directly.