> For the complete documentation index, see [llms.txt](https://docs.appmixer.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.appmixer.com/connector-configuration/figma.md).

# Figma

## OAuth app properties

| Property                | Value                                                                                                                                                        |
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **Multi-tenant**        | **Conditional.** Only a public app serves users of any Figma team or organization. A private app serves only users of the team or organization that owns it. |
| **Vendor review**       | **Required** for a public app: Figma reviews it before it can authorize users, and again after configuration changes. A private app needs no review.         |
| **Review time**         | Not published.                                                                                                                                               |
| **Users before review** | Members of the owning team or organization (private app). A draft app works only for you and the admins of your plan.                                        |
| **App owner**           | A Figma team or organization. Team or organization admins can reassign the app.                                                                              |
| **Regions**             | One app works worldwide.                                                                                                                                     |
| **Client secret**       | No expiry documented. It is shown only once, when you create the app.                                                                                        |
| **Rate limits**         | Per user, per plan and per app, so users do not share them. The limit depends on the endpoint tier and the user's seat and plan.                             |
| **Checked**             | 2026-11-13                                                                                                                                                   |

**Limitations**

* Users with a View or Collab seat get very low limits: up to 20 requests per month for Tier 1 endpoints such as GET file, and up to 5 or 10 per minute for the other tiers.
* Access tokens expire after 90 days by default. The connector renews them with the refresh token, which can be reused; no expiry is documented for it.
* The app must have every scope the connector requests enabled: `current_user:read`, `file_comments:read`, `file_comments:write`, `file_content:read`, `file_dev_resources:read`, `file_dev_resources:write`, `file_metadata:read`, `file_versions:read`, `library_assets:read`, `library_content:read`, `team_library_content:read`, `webhooks:read`, `webhooks:write`. The old `files:read` scope is replaced by these granular scopes.
* Apps created before 2025-09-23 that were not re-published by 2025-11-17 are in draft state and stop authorizing users until re-published.

Sources: [OAuth apps](https://developers.figma.com/docs/rest-api/oauth-apps/), [Authentication](https://developers.figma.com/docs/rest-api/authentication/), [Rate limits](https://developers.figma.com/docs/rest-api/rate-limits/), [Updates to Figma's Developer Platform](https://developers.figma.com/docs/updates-to-figmas-developer-platform/). What the rows mean: [OAuth app properties](https://docs.appmixer.com/connector-configuration/oauth-app-properties.md).

## Figma – Connector Configuration

### Step 1: Access Figma & Developer Platform

* Sign in to your Figma account at [Figma](https://www.figma.com/)
* Navigate to the [Figma Developer Platform](https://www.figma.com/developers)
* You need a Figma account to create applications (free account works)

> ⚠️ **Note**: Some API features require a Figma Professional or Organization plan.

***

### Step 2: Create Your Application

1. **Access Developer Settings**:
   * Go to **Account Settings** → **Connected apps**
   * Or visit: `https://www.figma.com/developers/apps`
2. **Create New App**:
   * Click **"Create new app"**
   * Fill in the application details:
     * **App name** (e.g., "Appmixer Design Integration")
     * **App description** - Describe your integration's purpose
     * **App website** - Your organization's website (optional)

***

### Step 3: Configure OAuth Settings

1. **OAuth Configuration**:
   * In your app settings, configure OAuth details
   * Set your callback URL for OAuth flow
2. **Set Callback URL**:
   * Add your OAuth redirect URI in the **"Callback URL"** field
   * For Appmixer, set the redirect URI to:

```http
https://[YOUR_API_BASE]/auth/figma/callback
```

Example:

```http
https://api.appmixer.com/auth/figma/callback
```

3. **OAuth Scopes**:
   * Figma OAuth provides access to:
     * **File access** - Read and write files
     * **Team access** - Access team information
     * **Webhook access** - Register and manage webhooks

***

### Step 4: Copy Your OAuth Credentials

After creating your application, you'll find:

* **Client ID** - Your OAuth application identifier
* **Client Secret** - Your OAuth application secret

⚠️ **Important**: Keep your Client Secret secure and never expose it in client-side code!

***

### Step 5: Personal Access Token (Alternative)

For server-to-server integrations, you can use personal access tokens:

1. **Generate Personal Access Token**:
   * Go to **Account Settings** → **Personal access tokens**
   * Click **"Create new token"**
   * Give it a descriptive name
   * Select appropriate scopes:
     * **File content** - Read file structure and content
     * **File comments** - Read and write comments
     * **File dev resources** - Access dev mode resources
2. **Token Security**:
   * Copy the token immediately (it won't be shown again)
   * Store securely and treat like a password
   * Tokens inherit your account permissions

***

### Step 6: Webhook Configuration (Optional)

Figma supports webhooks for real-time file updates:

1. **Create Webhook**:
   * Use the [Webhooks API](https://www.figma.com/developers/api#webhooks)
   * POST to `https://api.figma.com/v2/webhooks`
2. **Webhook Events**:
   * `FILE_UPDATE` - File content changes
   * `FILE_DELETE` - File deletion
   * `FILE_VERSION_UPDATE` - New version created
   * `LIBRARY_PUBLISH` - Library component published
3. **Webhook Payload Example**:

```json
{
  "event_type": "FILE_UPDATE",
  "file_key": "ABC123",
  "timestamp": "2023-01-01T12:00:00Z"
}
```

***

### Step 7: Rate Limits

**Rate Limits**:

* **Personal tokens**: 1000 requests per hour
* **OAuth apps**: 1000 requests per hour per user
* **Burst limit**: 120 requests per minute
* **File access**: Additional limits on large files

***

### Important Notes

⚠️ **File Access**:

* OAuth apps can only access files the user has permission to view
* Team files require appropriate team membership
* Private files require explicit sharing

⚠️ **API Limitations**:

* Read-only API (cannot modify file content via API)
* Comments and dev resources can be modified
* File exports have size and complexity limits

⚠️ **Webhook Delivery**:

* Webhooks may be delayed during high traffic
* Implement proper retry logic for failed deliveries
* Validate webhook signatures for security

***

### Useful Links

* [Figma API Documentation](https://www.figma.com/developers/api)
* [OAuth Documentation](https://www.figma.com/developers/api#oauth2)
* [Webhooks Guide](https://www.figma.com/developers/api#webhooks)
* [Plugin Development](https://www.figma.com/plugin-docs/)
* [Community Forum](https://forum.figma.com/c/developers-api/)
* [Rate Limits](https://www.figma.com/developers/api#rate-limiting)

## Backoffice configuration

Configuration ID: `appmixer:figma` (Backoffice → Configuration; see [Connector Configuration](https://docs.appmixer.com/getting-started/services) for how a configuration is created and how its keys reach the connector).

![alt text](https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-8b586707d5c8479c35ca31b722cd90704b6790ec%2Ffigma1.png?alt=media)

![alt text](https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-65d2fcc3c9bfd29b74c84528f2b7d86ab21b55ba%2Ffigma2.png?alt=media)

* `clientId` — Client ID of the Figma app created above. Not needed when Figma is authenticated through the Appmixer Auth Hub.
* `clientSecret` — Client secret of the same app. Not needed with the Auth Hub.
* `outputFilePrefix` — Optional. File name prefix of the CSV file that **FindComments** and **FindFileVersionHistory** create when their output is set to a file; the file is named `<prefix>-<component name>.csv`. Default `figma-export`.

The same keys can be set with the CLI (`-u` updates the existing configuration instead of creating it):

```bash
appmixer service-config set appmixer:figma -u -d '{
  "clientId": "<client id>",
  "clientSecret": "<client secret>"
}'
```


---

# 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.appmixer.com/connector-configuration/figma.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.
