Eve library

Notifications API Documentation

Guide

Revision 1

On this page

Overview#

Base URL#

text
http://localhost:3001/api/v1

Authentication#

All API endpoints require authentication via JWT token:

text
Authorization: Bearer <your-jwt-token>

Endpoints#

POST /v1/notifications/test#

Send a test notification (staff only)

Parameters: None

Responses:

  • 200: Test notification accepted
  • 400: No description
  • 401: No description
  • 403: No description
  • 429: No description
  • 500: No description

Operation ID: notificationTest

Rate Limiting#

All endpoints are subject to rate limiting:

  • Burst limit: 100 requests per minute
  • Sustained rate: 1000 requests per hour

Error Handling#

Standard error response format:

json
{
  "error": {
    "code": "ERROR_CODE",
    "message": "Human readable error message",
    "details": {}
  }
}

Generated automatically from OpenAPI specification