---
title: "List all project-defined events"
method: GET
path: "/project_defined_events"
tags: ["Project defined events"]
---

# List all project-defined events

`GET /project_defined_events`

## Response `200`

A list of `ProjectDefinedEvent` objects

- object
  - `project_defined_events` ProjectDefinedEvent[], required — An array of `ProjectDefinedEvent` objects
    - `id` string, required — The ID of the project defined event
    - `event` string, required — The event name. Likely takes the form `customer.created` or similar
    - `display_text` string, required — The human-readable text for this event. Should grammatically follow "When..." e.g. "a customer is created"
    - `purchase_amount_path` string, nullable, required — Path for extracting purchase amount from event data

---

[API](https://skmtc.dev/pocketflows/apis/pocketflows-api.md) · [All operations](https://skmtc.dev/pocketflows/apis/pocketflows-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/pocketflows/pocketflows-api/revisions/26723490b96f/schema)