Skip to content
POST/api/v1/events

Log a custom event

Records a custom event from external integrations (CI/CD, monitoring tools). Used for unified event-trail reporting.

Authentication

Send Authorization: Bearer YOUR_API_KEY on every request. Generate API keys at /dashboard/api-keys.

Request body required

Example

{
  "orgId": "00000000-0000-0000-0000-000000000000",
  "projectId": "00000000-0000-0000-0000-000000000000",
  "source": "firewall",
  "dedupKey": "string",
  "severity": "medium",
  "title": "string",
  "detail": "string",
  "payload": {},
  "resourceType": "string",
  "resourceId": "string",
  "actionHref": "https://example.com"
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "properties": {
        "orgId": {
          "type": "string",
          "format": "uuid",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
        },
        "projectId": {
          "nullable": true,
          "type": "string",
          "format": "uuid",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
        },
        "source": {
          "type": "string",
          "enum": [
            "firewall",
            "security",
            "compliance",
            "cost",
            "consent",
            "workflow",
            "eval",
            "ai_bom",
            "playbook",
            "siem",
            "agent",
            "gateway",
            "system"
          ]
        },
        "dedupKey": {
          "type": "string",
          "minLength": 1,
          "maxLength": 200
        },
        "severity": {
          "default": "medium",
          "type": "string",
          "enum": [
            "critical",
            "high",
            "medium",
            "low",
            "info"
          ]
        },
        "title": {
          "type": "string",
          "minLength": 1,
          "maxLength": 500
        },
        "detail": {
          "type": "string",
          "maxLength": 2000
        },
        "payload": {
          "type": "object",
          "additionalProperties": {}
        },
        "resourceType": {
          "type": "string",
          "maxLength": 100
        },
        "resourceId": {
          "type": "string",
          "maxLength": 200
        },
        "actionHref": {
          "type": "string",
          "format": "uri"
        }
      },
      "required": [
        "orgId",
        "source",
        "dedupKey",
        "severity",
        "title"
      ],
      "additionalProperties": false
    }
  }
}

Response

200 example

{
  "success": true
}

All status codes

200Event logged.
400(no description)
401(no description)
429(no description)

Code samples

cURL

curl -X POST \
  https://evalguard.ai/api/v1/events \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "orgId": "00000000-0000-0000-0000-000000000000", "projectId": "00000000-0000-0000-0000-000000000000", "source": "firewall", "dedupKey": "string", "severity": "medium", "title": "string", "detail": "string", "payload": {}, "resourceType": "string", "resourceId": "string", "actionHref": "https://example.com" }'

TypeScript

import { EvalGuard } from "@evalguard/sdk";

const client = new EvalGuard({ apiKey: process.env.EVALGUARD_API_KEY });

const response = await client.request({
  method: "POST",
  path: "/api/v1/events",
  body: {
    "orgId": "00000000-0000-0000-0000-000000000000",
    "projectId": "00000000-0000-0000-0000-000000000000",
    "source": "firewall",
    "dedupKey": "string",
    "severity": "medium",
    "title": "string",
    "detail": "string",
    "payload": {},
    "resourceType": "string",
    "resourceId": "string",
    "actionHref": "https://example.com"
  },
});
console.log(response);

Python

from evalguard import EvalGuard
import os

client = EvalGuard(api_key=os.environ["EVALGUARD_API_KEY"])

response = client.request(
    method="POST",
    path="/api/v1/events",
    body={
    "orgId": "00000000-0000-0000-0000-000000000000",
    "projectId": "00000000-0000-0000-0000-000000000000",
    "source": "firewall",
    "dedupKey": "string",
    "severity": "medium",
    "title": "string",
    "detail": "string",
    "payload": {},
    "resourceType": "string",
    "resourceId": "string",
    "actionHref": "https://example.com"
},
)
print(response)

Go

package main

import (
	"context"
	"fmt"
	"net/http"
	"os"
	"strings"
)

func main() {
	body := strings.NewReader(`{"orgId":"00000000-0000-0000-0000-000000000000","projectId":"00000000-0000-0000-0000-000000000000","source":"firewall","dedupKey":"string","severity":"medium","title":"string","detail":"string","payload":{},"resourceType":"string","resourceId":"string","actionHref":"https://example.com"}`)
	req, _ := http.NewRequestWithContext(context.Background(), "POST", "https://evalguard.ai/api/v1/events", body)
	req.Header.Set("Authorization", "Bearer "+os.Getenv("EVALGUARD_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil { panic(err) }
	defer resp.Body.Close()
	fmt.Println(resp.Status)
}

Errors

400401429

Other Monitoring endpoints