Create Monitoring Event

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

X-API-KEYstring

API Key authentication via header

This endpoint expects a list of objects or an object.

CreateWorkflowEventRequest0list of objectsRequired

WorkflowEventobjectRequired

countinteger

Number of events processed

successbooleanDefaults to true

Indicates whether the event was published successfully.

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

429

Too Many Requests Error

1	import requests
2
3	url = "https://api.vellum.ai/monitoring/v1/events"
4
5	payload = [
6	{
7	"name": "node.execution.initiated",
8	"body": {
9	"node_definition": {
10	"name": "string",
11	"module": ["string"],
12	"id": "string"
13	},
14	"inputs": {}
15	},
16	"id": "string",
17	"timestamp": "2024-01-15T09:30:00Z",
18	"trace_id": "string",
19	"span_id": "string"
20	}
21	]
22	headers = {
23	"X-API-KEY": "<apiKey>",
24	"Content-Type": "application/json"
25	}
26
27	response = requests.post(url, json=payload, headers=headers)
28
29	print(response.json())

1	import requests
2
3	url = "https://api.vellum.ai/monitoring/v1/events"
4
5	payload = [
6	{
7	"name": "node.execution.initiated",
8	"body": {
9	"node_definition": {
10	"name": "string",
11	"module": ["string"],
12	"id": "string"
13	},
14	"inputs": {}
15	},
16	"id": "string",
17	"timestamp": "2024-01-15T09:30:00Z",
18	"trace_id": "string",
19	"span_id": "string"
20	}
21	]
22	headers = {
23	"X-API-KEY": "<apiKey>",
24	"Content-Type": "application/json"
25	}
26
27	response = requests.post(url, json=payload, headers=headers)
28
29	print(response.json())