v1

latestOpenAPI 3.1.02026-07-24770322.0 KB

Create Event

This API endpoint creates a custom event in your workspace.

post/v1/events

Request body

eventTypestring required

The event type you wish to log. Max 100 characters. The stored value is prefixed with customEvent. (see Notes above).

eventDescriptionstring required

A human-readable description of the event. Max 500 characters.

actorIdstring

The UUID of the user the event pertains to. Recommended for platform API callers so the event is attributed to the correct actor.

companyIdstring

The UUID of the company the event pertains to. Required if actorId belongs to a client.

contextstring json required

A JSON object of key-value pairs describing the event. See notes above for the expected shape.

Response

Created

actorIdstring

actorTypestring

createdAtstring

eventDescriptionstring

eventTypestring

idstring

ipstring

objectstring

sourcestring

updatedAtstring

userAgentstring

Example response

{
  "actorId": "ab7bd961-0c87-4446-9037-ead4fbc3986f",
  "actorType": "internalUser",
  "context": {
    "clientName": "ari",
    "topic": "testing"
  },
  "createdAt": "2026-03-12T20:24:26.206496361Z",
  "eventDescription": "user starting testing in platform",
  "eventType": "customEvent.testing",
  "id": "35e1dd1d-5fe8-49e2-b154-7fc0506aabc1",
  "ip": "67.166.31.192",
  "object": "auditLog",
  "source": "platform",
  "updatedAt": "2026-03-12T20:24:26.206496361Z",
  "userAgent": "PostmanRuntime/7.37.3"
}