> ## Documentation Index
> Fetch the complete documentation index at: https://docs.photon.codes/docs/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Use Stable documentation by default. Honor an explicit Beta request or a URL under /docs/beta/. If the requested version conflicts with the installed CLI package or API origin, clarify the target before writing integration code.
> Pages under /docs/beta/ document Beta; other product pages document Stable. Keep the CLI package, commands, API origin, and credentials within the selected version. State the documentation version in your answer.
> For MCP search, always pass version: Stable or version: Beta. Unfiltered search mixes both versions. For filesystem reads, keep Beta queries under /beta/ and exclude /beta/ from Stable queries; discover paths before reading them.
> The public docs base is https://photon.codes/docs. Convert MCP page paths to public URLs under that base, preserving /beta/ when present. Read https://photon.codes/docs/skill.md for version selection and https://photon.codes/docs/llms.txt for the version indexes.

# ActionEvent

> Action event fired when a user clicks a button in a card.

```typescript
chat.onAction("approve", async (event) => {
  await event.thread.post(`Order ${event.value} approved by ${event.user.userName}`);
});
```

## Properties

<ResponseField name={"actionId"} type={"string"} required>
  The action ID from the button (matches Button's `id` prop)
</ResponseField>

<ResponseField name={"adapter"} type={"Adapter"} typeHref={"/reference/stable/chat/index/interfaces/Adapter"} required>
  The adapter that received the event
</ResponseField>

<ResponseField name={"messageId"} type={"string"} required>
  The message ID containing the card
</ResponseField>

<ResponseField name={"raw"} type={"unknown"} required>
  Platform-specific raw event data
</ResponseField>

<ResponseField name={"thread"} type={"Thread<TRawMessage, unknown> | null"} required>
  **Type:** <code>[Thread](/docs/reference/stable/chat/index/interfaces/Thread){"<TRawMessage, unknown> | null"}</code>

  The thread where the action occurred (null for view-based actions like home tab buttons)
</ResponseField>

<ResponseField name={"threadId"} type={"string"} required>
  The thread ID
</ResponseField>

<ResponseField name={"triggerId"} type={"string"}>
  Trigger ID for opening modals (required by some platforms, may expire quickly)
</ResponseField>

<ResponseField name={"user"} type={"Author"} typeHref={"/reference/stable/chat/index/interfaces/Author"} required>
  User who clicked the button
</ResponseField>

<ResponseField name={"value"} type={"string"}>
  Optional value/payload from the button
</ResponseField>

## Methods

### openModal()

```typescript
openModal(modal: ChatElement): Promise<{ viewId: string } | undefined>
```

Open a modal/dialog form in response to this action.

#### Parameters

<ResponseField name={"modal"} type={"ChatElement"} typeHref={"/reference/stable/chat/index/types/ChatElement"} required>
  The modal element to display (JSX or ModalElement)
</ResponseField>

#### Returns

`Promise<{ viewId: string } | undefined>`

The view/dialog ID, or undefined if modals are not supported


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.