> For the complete documentation index, see [llms.txt](https://docs.gridmate.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.gridmate.io/advanced-guides/user-grid/user-grid-custom-action.md).

# User Grid - Custom Action

Add custom actions, like a flow-calling mass convert, to a User Grid through Grid Action records.

## **Overview**

GridMate allows users to interact with and manipulate data by adding custom actions to the GM User Grid component.

{% hint style="info" %}
To set the **JSON** configuration of the action, please refer to [Grid - Mass/Record Actions](/advanced-guides/grid-actions/actions-library.md) and [Grid - Custom Action](/advanced-guides/grid-actions/grid-custom-action.md) articles.
{% endhint %}

## Custom Action Setup

In this guide, we walk through an example of setting up the call flow action.

{% stepper %}
{% step %}

### Open Custom Metadata Types

Click the gear icon in the top right corner, select **Setup**, then use the left-hand **Quick Find** search bar to type **Custom Metadata Types**.
{% endstep %}

{% step %}

### Manage the Grid Action records

Click **Manage Records** next to **Grid Action**.

<figure><img src="https://4046919449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MEsSbGy_U_OhthKUpxu%2Fuploads%2FHoRhxBlOhigeV4A9zBbT%2FScreenshot%202026-01-09%20at%2015.20.01.png?alt=media&amp;token=6cdaf301-e008-4bd8-acff-9f735a5aa582" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}

### Create the action

Click **New** to create a new custom action.

<figure><img src="https://4046919449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MEsSbGy_U_OhthKUpxu%2Fuploads%2Fl9QxdYLXT5YsWudGYnuR%2FScreenshot%202026-01-09%20at%2015.20.19.png?alt=media&amp;token=e9164e7e-669a-4712-98a1-0831ffb61e99" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}

### Save the action

After configuring the action, click **Save**.

<figure><img src="https://4046919449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MEsSbGy_U_OhthKUpxu%2Fuploads%2F2FZPTjbJqs9aCl5IW68s%2FScreenshot%202026-01-09%20at%2018.04.26.png?alt=media&amp;token=f25d6ba6-a23d-4af4-aae6-1ed739acdddb" alt=""><figcaption></figcaption></figure>
{% endstep %}
{% endstepper %}

Below is an example of the configuration used for the **mass convert** call flow **action**.

```json
{
    "label": "Mass Convert",
    "name": "MassConvert",
    "component": "gmpkg:DataGridCallFlowComponent",
    "attributes": {
        "flowName": "GM_Mass_Lead_Convert",
        "idListParam": "idList",
        "itemListParam": "itemList",
        "autolaunched": false,
        "successMessage": "Leads converted successfully"
    }
}
```

## Next steps

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>User Grid</strong></td><td>Create and configure your own grids from the Config Wiz.</td><td><a href="/product-tour/grids/user-grid.md">User Grid</a></td></tr><tr><td><strong>Grid - Custom Action</strong></td><td>Launch your own Aura or LWC component as a grid action.</td><td><a href="/advanced-guides/grid-actions/grid-custom-action.md">Grid - Custom Action</a></td></tr><tr><td><strong>Grid - Mass/Record Actions</strong></td><td>Configure toolbar, global and record actions, from filters to flows.</td><td><a href="/advanced-guides/grid-actions/actions-library.md">Grid - Mass/Record Actions</a></td></tr></tbody></table>


---

# 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.gridmate.io/advanced-guides/user-grid/user-grid-custom-action.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.