> For the complete documentation index, see [llms.txt](https://gitbook.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://gitbook.com/docs/developers/integrations/development/contentkit/actions.md).

# Actions

Reference for built-in and custom ContentKit actions

ContentKit actions handle events in your component. GitBook provides built-in actions, and your component can define custom actions.

### Built-in actions

#### `@editor.node.updateProps`

Updates properties stored on the editor node bound to the current component. GitBook dispatches this action when component props change:

```json
{
  "action": "@editor.node.updateProps",
  "props": {}
}
```

#### `@ui.url.open`

Opens a URL:

```json
{
  "action": "@ui.url.open",
  "url": "https://www.gitbook.com"
}
```

#### `@ui.modal.open`

Opens `componentId` as an overlay modal with `props`:

```json
{
  "action": "@ui.modal.open",
  "componentId": "myModal",
  "props": {}
}
```

#### `@ui.modal.close`

Closes the current modal. Call this action from a modal component. It can include return data from the modal:

```json
{
  "action": "@ui.modal.close"
}
```

#### `@webframe.ready`

Signals that a webframe is ready to receive messages and updates:

```json
{
  "action": "@webframe.ready"
}
```

#### `@webframe.resize`

Resizes a webframe container:

```json
{
  "action": "@webframe.resize",
  "aspectRatio": 1.7,
  "maxHeight": 400,
  "maxWidth": 300
}
```

#### `@link.unfurl`

GitBook sends this action to a block when someone pastes a matching URL:

```json
{
  "action": "@link.unfurl",
  "url": "https://myapp.com/"
}
```

Configure URL patterns in your integration manifest:

```yaml
blocks:
  - id: helloworld
    title: Hello world
    urlUnfurl:
      - https://myapp.com/
```

Follow [Create a custom unfurl action](/docs/developers/integrations/guides/create-a-custom-unfurl-action-for-your-integration.md) for a complete example.

### Custom actions

Define custom action names in your component. The action name is available on the `action` object:

```typescript
action: async (previous, action) => {
  switch (action.action) {
    case 'custom-action':
      return {};
    default:
  }
}
```


---

# 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://gitbook.com/docs/developers/integrations/development/contentkit/actions.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.