---
title: "Ingest customer activity events"
method: POST
path: "/api/i/v1/{publicKey}/events"
---

# Ingest customer activity events

`POST /api/i/v1/{publicKey}/events`

## Path parameters

- `publicKey` string, required

## Request body

- IngestPayload
  - `visitorId` string, uuid
  - `fingerprint` string
  - `source` 'client' | 'server' | 'integration'
  - `events` union[], required
    - union
      - object
        - `uuid` string, uuid
        - `type` 'pageview', required
        - `timestamp` number, required
        - `url` string, uri, required
        - `path` string, required
        - `referrer` string
        - `utm` object
          - `source` string
          - `medium` string
          - `campaign` string
          - `term` string
          - `content` string
          - `ref` string
        - `customerId` string
        - `customerTraits` object
        - `title` string
      - object
        - `uuid` string, uuid
        - `type` 'form', required
        - `timestamp` number, required
        - `url` string, uri, required
        - `path` string, required
        - `referrer` string
        - `utm` object
          - `source` string
          - `medium` string
          - `campaign` string
          - `term` string
          - `content` string
          - `ref` string
        - `customerId` string
        - `customerTraits` object
        - `formId` string
        - `formFields` object
      - object
        - `uuid` string, uuid
        - `type` 'identify', required
        - `timestamp` number, required
        - `url` string, uri, required
        - `path` string, required
        - `referrer` string
        - `utm` object
          - `source` string
          - `medium` string
          - `campaign` string
          - `term` string
          - `content` string
          - `ref` string
        - `email` string, email
        - `userId` string
        - `fingerprint` string
        - `customerId` string
        - `customerTraits` object
        - `traits` object
      - object
        - `uuid` string, uuid
        - `type` 'custom', required
        - `timestamp` number, required
        - `url` string, uri, required
        - `path` string, required
        - `referrer` string
        - `utm` object
          - `source` string
          - `medium` string
          - `campaign` string
          - `term` string
          - `content` string
          - `ref` string
        - `customerId` string
        - `customerTraits` object
        - `email` string, email
        - `userId` string
        - `fingerprint` string
        - `eventName` string, required
        - `properties` object
      - object
        - `uuid` string, uuid
        - `type` 'calendar', required
        - `timestamp` number, required
        - `url` string, uri, required
        - `path` string, required
        - `referrer` string
        - `utm` object
          - `source` string
          - `medium` string
          - `campaign` string
          - `term` string
          - `content` string
          - `ref` string
        - `customerId` string
        - `customerTraits` object
        - `provider` 'cal.com' | 'calendly' | 'unknown', required
        - `eventType` string
        - `startTime` string
        - `endTime` string
        - `duration` number
        - `isRecurring` boolean
        - `inviteeEmail` string, email
        - `inviteeName` string
      - object
        - `uuid` string, uuid
        - `type` 'engagement', required
        - `timestamp` number, required
        - `url` string, uri, required
        - `path` string, required
        - `referrer` string
        - `utm` object
          - `source` string
          - `medium` string
          - `campaign` string
          - `term` string
          - `content` string
          - `ref` string
        - `customerId` string
        - `customerTraits` object
        - `activeTimeMs` number, required
        - `totalTimeMs` number, required
        - `sessionId` string, uuid, required
  - `sessionId` string, uuid
  - `userIdentity` object
    - `email` string, email
    - `userId` string
    - `fingerprint` string
    - `traits` object
  - `customerIdentity` object
    - `customerId` string
    - `customerTraits` object

## Response `200`

Ingestion result

- IngestResponse
  - `success` boolean, required
  - `processed` integer, required
  - `errors` object[]
    - `index` integer, required
    - `message` string, required

## Other responses

- `207` — Partial ingestion result
- `400` — Invalid ingestion request
- `500` — Ingestion failure

---

[API](https://skmtc.net/outlitai/apis/outlit-api.md) · [All operations](https://skmtc.net/outlitai/apis/outlit-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/outlitai/outlit-api/versions/5657e401e81d/schema)