---
title: "POST /projects/{projectId}/events"
method: POST
path: "/projects/{projectId}/events"
tags: ["Events"]
---

# POST /projects/{projectId}/events

`POST /projects/{projectId}/events`

## Request

- Base URL: `https://api.embeddables.com`
- URL: `https://api.embeddables.com/projects/{projectId}/events`
- Auth: none declared. Required headers: `X-Api-Key`

Submit a custom event for an entry

## Path parameters

- `projectId` string, required: The unique identifier for a Project in the database

## Headers

- `X-Api-Key` string, required

## Request body

- EntryEventRequest
  - `embeddable_id` string, required: The unique identifier for a Embeddable in the database
  - `timestamp` string, required: A Date + Time string in ISO format
  - `custom_event_name` string, required: A name of your choosing for the custom event - must be snake_case
  - `custom_event_props` string, required: Any custom properties you want to attach to the custom event - must be a valid JSON string
  - `identifiers` Identifier[], required: A list of key-value pairs that uniquely identify the end-user that this event should be attached to. Currently supports one key-value pair. The value must be JSON-stringified, so strings must be wrapped in double-quotes.
    - `key` string, required
    - `value` string, required

## Response `200`

- Event
  - `entry_id` string, required: The unique identifier for an Entry in the database
  - `contact_id` string, required: The unique identifier for a Contact in the database
  - `project_id` string, required: The unique identifier for a Project in the database
  - `group_id` string, required: The unique identifier for a Group in the database
  - `embeddable_id` string, required: The unique identifier for a Embeddable in the database
  - `embeddable_version_number` integer: The version number of an embeddable
  - `timestamp` string, required: A Date + Time string in ISO format
  - `page_id` string
  - `page_key` string
  - `page_index` integer
  - `max_page_id` string
  - `max_page_key` string
  - `max_page_index` integer
  - `total_pages` integer, nullable
  - `event_type` string, required
  - `view_type` string
  - `custom_event_name` string, nullable
  - `custom_event_props` string, nullable

## Other responses

- `401`
- `404`

## Changes

- **2024-10-17** `d437a74f97ca`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/heysavvy/apis/embeddables-api/changes/projects/:projectId/events/post.md)

---

[API](https://skmtc.dev/heysavvy/apis/embeddables-api.md) - [All operations](https://skmtc.dev/heysavvy/apis/embeddables-api/llms.txt) - [OpenAPI document](https://skmtc.dev/heysavvy/apis/embeddables-api/revisions/8aef37932517?raw)
