Create Monitoring Event | Vellum

import datetime
from vellum import (
    NodeExecutionInitiatedBody,
    NodeExecutionInitiatedEvent,
    Vellum,
    VellumCodeResourceDefinition,
)
client = Vellum(
    api_version="YOUR_API_VERSION",
    api_key="YOUR_API_KEY",
)
client.events.create(
    request=[
        NodeExecutionInitiatedEvent(
            body=NodeExecutionInitiatedBody(
                node_definition=VellumCodeResourceDefinition(
                    name="name",
                    module=["module", "module"],
                    id="id",
                ),
                inputs={"inputs": {"key": "value"}},
            ),
            id="id",
            timestamp=datetime.datetime.fromisoformat(
                "2024-01-15 09:30:00+00:00",
            ),
            trace_id="trace_id",
            span_id="span_id",
        ),
        NodeExecutionInitiatedEvent(
            body=NodeExecutionInitiatedBody(
                node_definition=VellumCodeResourceDefinition(
                    name="name",
                    module=["module", "module"],
                    id="id",
                ),
                inputs={"inputs": {"key": "value"}},
            ),
            id="id",
            timestamp=datetime.datetime.fromisoformat(
                "2024-01-15 09:30:00+00:00",
            ),
            trace_id="trace_id",
            span_id="span_id",
        ),
    ],
)

{
  "count": 1,
  "success": true
}

Accept an event or list of events and publish them to ClickHouse for analytics processing.

Authentication

X-API-KEYstring

API Key authentication via header

Request

This endpoint expects a list of objects or an object.

CreateWorkflowEventRequest0list of objectsRequired

WorkflowEventobjectRequired

Response

countinteger

Number of events processed

successbooleanDefaults to true

Indicates whether the event was published successfully.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

429

Too Many Requests Error

Authentication

Headers

Request

Response

Errors