---
title: "Create Event"
method: POST
path: "/v1/events"
---

# Create Event

`POST /v1/events`

This API endpoint creates a custom event in your workspace.

## Request body

- object
  - `eventType` string, required — The event type you wish to log. Max 100 characters. The stored value is prefixed with `customEvent`. (see Notes above).
  - `eventDescription` string, required — A human-readable description of the event. Max 500 characters.
  - `actorId` string — The UUID of the user the event pertains to. Recommended for platform API callers so the event is attributed to the correct actor.
  - `companyId` string — The UUID of the company the event pertains to. Required if `actorId` belongs to a client.
  - `context` string, json, required — A JSON object of key-value pairs describing the event. See notes above for the expected shape.

## Response `201`

Created

- object
  - `actorId` string
  - `actorType` string
  - `context` object
    - `clientName` string
    - `topic` string
  - `createdAt` string
  - `eventDescription` string
  - `eventType` string
  - `id` string
  - `ip` string
  - `object` string
  - `source` string
  - `updatedAt` string
  - `userAgent` string

---

[API](https://skmtc.net/assembly/apis/core-resources.md) · [All operations](https://skmtc.net/assembly/apis/core-resources/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/assembly/core-resources/versions/28a9e7d13a8c/schema)