Developer API Reference

Eventium API Reference.

This page is the technical reference. Use it for exact request shapes, authentication headers, webhook endpoints, MCP transport examples, and the interactive OpenAPI console.

Manage API Keys OpenAPI JSON OpenAPI YAML Developer Hub

Primary auth

Bearer or X-Api-Key

Role

Technical reference

Best for

Implementation details

Start here

Use the public developer entrypoints

Use this page when you need exact contract details. For higher-level integration onboarding, use the Developer Hub instead.

REST API

Exact schema and live request inspection for direct HTTP integrations.

  • https://api.eventium.ai/api/openapi.json
  • https://api.eventium.ai/api/openapi.yaml
  • Generated clients and typed SDKs

Hosted MCP

Exact transport examples for tool-based agent integrations.

  • POST https://mcp.eventium.ai/mcp
  • Public transport secured by Eventium API keys
  • Human UI at /keys

Authentication

Use API keys for servers and Bearer tokens for user-backed sessions

Long-lived application access should use X-Api-Key. Browser-backed user sessions can use Bearer auth. Browser Basic Auth is not the intended public model for api.eventium.ai.

API key

Recommended for servers, CI, agent runtimes, and MCP clients.

curl -sS https://api.eventium.ai/api/health \
  -H "X-Api-Key: EVENTIUM-REPLACE-ME"

Bearer token

Use for signed-in browser sessions and short-lived user-scoped calls.

curl -sS https://api.eventium.ai/api/health \
  -H "Authorization: Bearer YOUR_JWT"

Key management

Create, rotate, revoke, and delete keys from the hosted key management surface.

Open Manage API Keys

MCP

Connect IDEs and agents through the hosted Eventium MCP

Use this section for the exact MCP transport request shape and generic client config.

MCP transport

curl -sS https://mcp.eventium.ai/mcp \
  -H "Content-Type: application/json" \
  -H "X-API-Key: EVENTIUM-REPLACE-ME" \
  -d '{"jsonrpc":"2.0","id":"1","method":"tools/list","params":{}}'

Generic MCP config

{
  "name": "Eventium MCP",
  "transport": "http",
  "url": "https://mcp.eventium.ai/mcp",
  "headers": {
    "X-API-Key": "EVENTIUM-REPLACE-ME"
  }
}

Webhooks

Integrate async delivery without polling

Use webhooks when your application needs lifecycle or delivery notifications from Eventium.

Endpoint management

  • GET /api/webhooks/endpoints
  • POST /api/webhooks/endpoints
  • PATCH /api/webhooks/endpoints/{id}
  • DELETE /api/webhooks/endpoints/{id}

Delivery operations

  • GET /api/webhooks/deliveries
  • POST /api/webhooks/test
  • Inspect status and validate integrations

Event types

  • GET /api/webhooks/events
  • Discover supported event names
  • Use the schema as the contract source

SDKs and clients

Generate clients from the schema and keep integrations aligned

Use the live OpenAPI description as the source of truth for generated clients and typed request models.

OpenAPI

Use the live JSON or YAML schema as the contract source.

  • /api/openapi.json
  • /api/openapi.yaml
  • Works with standard generators

Python guide

Use the Python integration guide for quick-start client examples.

Quick tests

Validate the public integration surface

Use these examples to confirm the live API and MCP transport are responding correctly.

Fetch the OpenAPI schema

curl -sS https://api.eventium.ai/api/openapi.json -o openapi.json
curl -sS https://api.eventium.ai/api/openapi.yaml -o openapi.yaml

Health check

curl -sS https://api.eventium.ai/api/health \
  -H "X-Api-Key: EVENTIUM-REPLACE-ME"

Interactive reference

Current public OpenAPI specification

Inspect request shapes, authenticate with a Bearer token or API key, and run live calls against the current public integration surface.