> For the complete documentation index, see [llms.txt](https://docs.pyck.cloud/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.pyck.cloud/graphql-api/types/event.md).

# Event

Event Type

Represents an event schema/template in the system. Events define the structure for messages that can be published and consumed within the pyck event-driven architecture.

## Fields

| Field         | Type      | Description                                |
| ------------- | --------- | ------------------------------------------ |
| `id`          | `ID!`     | Unique identifier of the event             |
| `createdAt`   | `Time!`   | Creation timestamp                         |
| `createdBy`   | `UUID!`   | User identifier who created the event      |
| `updatedAt`   | `Time`    | Last update timestamp                      |
| `updatedBy`   | `UUID`    | User identifier who last updated the event |
| `deletedAt`   | `Time`    | Deletion timestamp                         |
| `deletedBy`   | `UUID`    | User identifier who deleted the event      |
| `topic`       | `String!` | NATS topic for the event                   |
| `name`        | `String!` | Name of the event                          |
| `description` | `String!` | Description of the event                   |
| `example`     | `Map`     | Example event payload structure            |

## Interfaces

* `Node`

## Usage Example

```graphql
query {
  events(first: 10) {
    edges {
      node {
        id
        topic
        name
        description
        example
        createdAt
        updatedAt
      }
    }
  }
}
```

## Purpose

Events serve as templates/schemas for defining the structure of messages in the system's event-driven architecture. They help ensure consistency and provide documentation for the expected payload structure when publishing or consuming events through NATS messaging.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.pyck.cloud/graphql-api/types/event.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.