# events

**Type:** GraphQL subscriptions

**Description:**
Subscribe to on-chain events by their fully qualified name (e.g., `coin.TRANSFER`).

Streams matching events in real time once their containing blocks meet the required confirmation depth.
Useful for explorers, wallets, indexers, and analytics apps.

`parametersFilter` must be a stringified JSON using Prisma JSON property filter syntax.
Example:
  events(
    qualifiedEventName: "coin.TRANSFER",
    parametersFilter: "{\"array_starts_with\": \"k:abcdefg\"}"
  )

`quantity` controls the size of the initial payload (default: 20); new events are pushed thereafter.

## Arguments
- chainId (String): (Optional) Restrict the subscription to a specific chain.
If omitted, events from all chains are included.
- minimumDepth (Int): (Optional) Minimum number of confirmations a block must have before its events are emitted.
- parametersFilter (String): (Optional) A stringified JSON object used to filter event parameters.
Must follow Prisma’s JSON property filter syntax.
Example: "{\"array_starts_with\": \"k:abcdefg\"}"
- qualifiedEventName (String): The fully qualified event name to subscribe to.
Example: "coin.TRANSFER".
- quantity (Int): Number of most recent matching events to include in the initial payload.
Defaults to 20.

## Response
**Type:** Event
**Description:**
Represents an event emitted during the execution of a smart contract function.

Events are structured outputs generated by Pact code when certain actions occur on-chain —
such as token transfers, mints, burns, or other contract-specific behaviors. They are commonly
used by explorers, indexers, wallets, and analytics tools to track contract activity, monitor
state changes, and trigger off-chain processes.

Each event is associated with a specific block, transaction, and request key, and includes
metadata like its qualified name (`moduleName.eventName`), parameters, and position within the transaction.

### Fields
- id (ID): Globally unique identifier for this event.
- name (String): The name of the event as defined in the smart contract.
Example: `"TRANSFER"`.
- block (Block): The block in which this event was emitted.
- chainId (BigInt): The ID of the chain where the event occurred.
- height (BigInt): The height of the block in which this event was emitted.
- moduleName (String): The name of the module that emitted the event.
Example: `"coin"`.
- orderIndex (BigInt): The index position of this event within the transaction’s event list.
Useful when multiple events are emitted by the same transaction.
- requestKey (String): The request key of the transaction that emitted this event.
- parameters (String): The raw JSON-encoded event parameters as emitted by the contract.
- parameterText (String): A human-readable text representation of the event parameters.
- qualifiedName (String): The fully qualified event name, combining the module and event name.
Example: `"coin.TRANSFER"`.
- transaction (Transaction): The transaction that emitted this event.