> 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/queries/events.md).

# Events

Events Query

Returns a paginated list of Event objects, with optional filtering and ordering. Events represent system events that can be published to NATS messaging system.

## Arguments

| Name      | Type              | Description                                                            |
| --------- | ----------------- | ---------------------------------------------------------------------- |
| `after`   | `Cursor`          | Returns the elements in the list that come after the specified cursor  |
| `first`   | `Int`             | Returns the first *n* elements from the list                           |
| `before`  | `Cursor`          | Returns the elements in the list that come before the specified cursor |
| `last`    | `Int`             | Returns the last *n* elements from the list                            |
| `orderBy` | `EventOrder`      | Ordering options for events returned from the connection               |
| `where`   | `EventWhereInput` | Filtering options for events returned from the connection              |

## Return Type

`EventConnection!` - A connection to a list of Event objects with pagination information.

## Usage Example

```graphql
query {
  # Search events by topic
  events(
    where: {
      topicContains: "inventory"
    },
    orderBy: { direction: DESC, field: CREATED_AT }
  ) {
    edges {
      node {
        id
        topic
        name
        description
        example
        createdAt
        createdBy
      }
      cursor
    }
    totalCount
  }
}
```

```graphql
query {
  # Get events created recently
  events(
    where: {
      createdAtGTE: "2024-01-01T00:00:00Z"
    },
    first: 20
  ) {
    edges {
      node {
        id
        topic
        name
        description
        example
        createdAt
      }
    }
    pageInfo {
      hasNextPage
      hasPreviousPage
      startCursor
      endCursor
    }
  }
}
```

```graphql
query {
  # Find specific event by name
  events(
    where: {
      nameContains: "item_created"
    }
  ) {
    edges {
      node {
        id
        topic
        name
        description
        example
      }
    }
  }
}
```

## Common Filters

* `topicContains` - Search by NATS topic substring
* `topic` - Find by exact topic name
* `nameContains` - Search by event name substring
* `name` - Find by exact event name
* `descriptionContains` - Search by description content
* `createdAtGTE` / `createdAtLTE` - Filter by creation date range

## Notes

* Events define the structure and metadata for system messages
* Each event has a NATS topic for message routing
* Example field contains sample payload structure
* Events are used for inter-service communication and workflow triggers
* Support audit trail through creation and update timestamps
* Essential for event-driven architecture and real-time notifications


---

# 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/queries/events.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.