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

# Figma

> Collaborative interface design and inspection via your connected account.

Use this app when your workflow needs Figma file data, node details, comments, or library assets. Add comments or dev resources after you find the right file or node.

## Configuration

| Option | Required | Description |
| - | - | - |
| Name | No | Label for the step in the workflow canvas. |
| Authentication | Yes | The connected Figma account to use for this step. |
| Action | Yes | The Figma action to perform (for example Get current user, Get file metadata, Get file json, Get file nodes). |
| Arguments | Yes | Per-action form fields generated from the action's schema. Each text field has an **Insert Variable** button for injecting `{{placeholder}}` values. A **Raw JSON** tab is available for advanced usage. |
| When the step fails | No | Controls whether the workflow should **Terminate Workflow** or **Continue** if this step fails. |

Before you configure this step, connect Figma in **Integrations** for your workspace using the sign-in flow. If no active connection is available, the step shows a warning with a link to **Integrations** instead of the account selector.

## Arguments form

When you select an action, the **Arguments** section renders a form driven by the action's input schema. Fields that refer to existing records include dropdown pickers.

Switch to the **Raw JSON** tab when you prefer to write the full arguments object by hand. Changes in either tab stay in sync.

## Common actions

| Action | Description |
| - | - |
| **Get current user** | Retrieve the connected Figma user details. |
| **Get file metadata** | Fetch metadata for a Figma file. |
| **Get file json** | Fetch simplified design data for a Figma file. |
| **Get file nodes** | Fetch JSON for specific nodes in a Figma file. |
| **Render node images** | Render selected Figma nodes as images. |
| **Download images** | Download images from nodes in a Figma file. |
| **Get comments** | List comments from a Figma file. |
| **Add comment** | Post a new comment to a Figma file. |
| **Get dev resources** | List development resources attached to a Figma file. |
| **Get team components** | List components published in a team library. |
| **Get file components** | List published components in a main Figma file. |
| **Get file styles** | List published styles in a main Figma file. |
| **Get local variables** | List variables available in a Figma file. |

Destructive actions, such as deleting records, are not available in the workflow action picker.

## Output

This step stores the Figma response as the step output. The shape of the response depends on the action.

Use the full output reference in later steps:

```text theme={null}
{{STEP_IDENTIFIER.output}}
```

## Example

1. Open **Integrations** and connect Figma if you have not already done that.
2. Add a **Figma** step to your workflow.
3. Select a connected account in **Authentication**.
4. Choose **Get current user** in **Action**.
5. Fill in the required fields. Use **Insert Variable** to reference an earlier step's output for any field value.
6. Click **Run** in the step header to test the action, then review the returned payload in **Output**.

## Use cases

### Review a design file

1. Get file metadata
2. Get comments
3. Add comment

### Inspect selected nodes

1. Get file nodes
2. Render node images
3. Download images

### Link developer resources

1. Get dev resources
2. Create dev resources
3. Update dev resources

## Notes

* This step depends on a connected Figma integration in your workspace.
* The workflow action picker shows a curated set of actions. Agents with the Figma tool can use more of them.
* The sign-in screen may show third-party authorization branding.

## Using Figma as an Agent Tool

You can also add Figma as a tool in the **Agent Editor**. Open the agent, click **Add tool**, and select **Figma**. In the tool settings panel, choose the connected account the agent should use. The agent calls Figma actions when they are relevant to the conversation.

See also: [Integrations](https://docs.fetchhive.com/workspace/integrations.md), [Creating and Editing](https://docs.fetchhive.com/workflows/creating-and-editing.md), and [Testing and Iteration](https://docs.fetchhive.com/workflows/testing-and-iteration.md)


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