Loading

Figma connector

The Figma connector communicates with the Figma REST API to browse design files, inspect document structure, render nodes as images, and explore team projects. It is used as a data source for Workplace AI (for example Agent Builder).

You can create connectors in Stack Management > Connectors.

Figma connectors use API key (header) authentication:

X-Figma-Token
A Figma personal access token. See Get API credentials for how to obtain it.

You can test connectors when creating or editing the connector in Kibana. The test verifies connectivity by calling the Figma API to fetch the current user (for example handle or email).

The Figma connector has the following actions:

Who am I
Get the currently authenticated Figma user. Returns the user's id, handle, email, and img_url for the API credentials in use. No parameters.
List team projects

List all projects in a Figma team. Returns teamId (for use in later steps) and project list. Use the returned project IDs with List project files to browse files. Provide either teamId or url; if you do not have the team ID, ask the user to paste the team page URL.

  • teamId (optional): The Figma team ID from the team page URL. If not available, use url instead or ask the user to paste the team page URL.
  • url (optional): Figma team page URL (for example figma.com/team/123/Team-Name). The team ID will be extracted. If neither teamId nor url is provided, ask the user to paste the team page URL.
List project files

List all files in a Figma project. Returns file names, keys, thumbnail URLs, and last modified dates. Use the returned file keys with Get file or Render nodes.

  • projectId (required): The Figma project ID (from List team projects or the project URL).
Get file

Get a Figma file's structure, metadata, components, and styles. The file key can be taken from any Figma file URL: https://www.figma.com/file/FILE_KEY/....

  • fileKey (required): The file key from the Figma file URL.
  • node_ids (optional): Comma-separated node IDs to retrieve specific nodes (for example 1:2,1:3).
  • depth (optional): How deep into the document tree to traverse. 1 = pages only; 2 = pages and top-level objects. Omit or increase for the full tree. Defaults to 2.
Render nodes

Render Figma nodes as images. Returns temporary image URLs (valid for 30 days). Supports PNG, JPG, SVG, and PDF.

  • fileKey (required): The file key from the Figma file URL.
  • node_ids (required): Comma-separated node IDs to render (for example 1:2,1:3). Find node IDs in Figma URLs (?node-id=1:2) or from Get file output.
  • format (optional): Image format: png, jpg, svg, or pdf. Defaults to png.
  • scale (optional): Scale factor between 0.01 and 4. Defaults to 1.

Figma does not provide a full-text search over files. Discovery is hierarchical: use List team projects (with a team ID or team page URL), then List project files (with a project ID), then Get file (and optionally Render nodes). When using this connector as a data source in chat or Agent Builder, users navigate by team and project; there is no single "search my Figma files for X" action. The Figma REST API does not offer a global search endpoint.

Use the Action configuration settings to customize connector networking configurations, such as proxies, certificates, or TLS settings. You can set configurations that apply to all your connectors or use xpack.actions.customHostSettings to set per-host configurations.

<a id="figma-api-credentials"></a>

To use the Figma connector, you need a Figma personal access token:

  1. Log in to Figma.
  2. Open your Account settings (profile menu → Settings, or Figma account settings).
  3. Scroll to Personal access tokens and click Generate new token.
  4. Name the token (for example "Kibana Figma connector") and copy the token value.
  5. Use this value as X-Figma-Token in the connector configuration. The connector sends it in the X-Figma-Token header per the Figma REST API.

Keep the token secret because it grants access to your Figma account and files shared with you.