---
title: "Create custom event"
method: POST
path: "/v1/events/custom"
tags: ["Custom events"]
---

# Create custom event

`POST /v1/events/custom`

## Request

- Base URL: `https://app.aptrinsic.com`
- URL: `https://app.aptrinsic.com/v1/events/custom`
- Auth: none declared
- TypeScript: <https://skmtc.dev/gainsight/apis/gainsight-px-rest-api/docs/v1/events/custom/post.ts> (a function with typed inputs; its response is checked against the schema)

Creates custom event with the given data

## Request body

- CustomEvent: Custom Event object
  - `eventId` string
  - `identifyId` string, required
  - `propertyKey` string, required
  - `date` integer
  - `eventType` string
  - `sessionId` string
  - `userType` 'LEAD' | 'USER' | 'VISITOR' | 'EMPTY_USER_TYPE', required
  - `accountId` string
  - `globalContext` object
  - `eventName` string, required
  - `attributes` object
  - `url` string
  - `referrer` string
  - `remoteHost` string

## Response `201`

Create custom events

- ResponseEntity
  - `body` object
  - `statusCode` '100' | '101' | '102' | '103' | '200' | '201' | '202' | '203' | '204' | '205' | '206' | '207' | '208' | '226' | '300' | '301' | '302' | '303' | '304' | '305' | '307' | '308' | '400' | '401' | '402' | '403' | '404' | '405' | '406' | '407' | '408' | '409' | '410' | '411' | '412' | '413' | '414' | '415' | '416' | '417' | '418' | '419' | '420' | '421' | '422' | '423' | '424' | '426' | '428' | '429' | '431' | '451' | '500' | '501' | '502' | '503' | '504' | '505' | '506' | '507' | '508' | '509' | '510' | '511'
  - `statusCodeValue` integer

## Other responses

- `400`: Bad request
- `401`: Unauthorized or bad API Key
- `429`: Rate limit exceeded
- `500`: Internal error

---

[API](https://skmtc.dev/gainsight/apis/gainsight-px-rest-api.md) - [All operations](https://skmtc.dev/gainsight/apis/gainsight-px-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/gainsight/apis/gainsight-px-rest-api/revisions/e7b197b373d8?raw)