Emit a project event

Stores one timestamped project event. Event names must be lowercase and may contain optional dot-separated segments; each segment starts with a lowercase letter and may contain lowercase letters, numbers, and underscores. conversation_id is optional; include it when the event belongs to a WhatsApp conversation.

post/events

Request

Base URL
https://api.kapso.ai/platform/v1
Auth
API key in header X-API-Key
TypeScript
https://skmtc.dev/kapso/apis/kapso-platform-api/docs/events/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

namestring required

Event name. Must be lowercase and may contain optional dot-separated segments. Each segment starts with a lowercase letter and may contain lowercase letters, numbers, and underscores. Maximum 128 characters.

occurred_atstring date-time

Optional event timestamp. Defaults to the current time.

conversation_idstring uuid

Optional WhatsApp conversation ID to link to the event

propertiesobject

Optional flat event properties object

Example request

{
  "name": "conversation.csat_scored"
}

Response

Event created

Example response

{
  "data": {
    "name": "conversation.csat_scored"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.