Beyond-Bot.ai + figma
A collaborative interface design tool.
What You Can Do with this Integration
Automate Data Entry
Automatically sync new contacts or deals from Beyond-Bot.ai to figma.
Enrich Customer Profiles
Use Beyond-Bot.ai to find and add new information to your records in figma.
Trigger Workflows
Start automated workflows in figma based on conversations with your virtual expert.
Available Actions
Here are the specific actions your virtual expert can perform within figma.
Add A Comment To A File
Posts a new comment to a figma file or branch, optionally replying to an existing root comment (replies cannot be nested); `region height` and `region width` in `client meta` must be positive if defining a comment region.
Add A Reaction To A Comment
Posts a specified emoji reaction to an existing comment in a figma file or branch, requiring valid file key and comment id.
Create A Webhook
Creates a figma webhook for a `team id` to send post notifications for an `event type` to a publicly accessible https `endpoint`; an initial ping is sent unless `status` is `paused`.
Create Dev Resources
Creates and attaches multiple uniquely-urled development resources to specified figma nodes, up to 10 per node.
Create, Modify, Or Delete Variables
Manages variables, collections, modes, and their values in a figma file via batch create/update/delete operations; use temporary ids to link new related items in one request and ensure `variablemodevalues` match the target variable's `resolvedtype`.
Delete A Comment
Deletes a specific comment from a figma file or branch, provided the authenticated user is the original author of the comment.
Delete A Reaction
Deletes a specific emoji reaction from a comment in a figma file; the user must have originally created the reaction.
Delete A Webhook
Permanently deletes an existing webhook, identified by its unique `webhook id`; this operation is irreversible.
Delete Dev Resource
Deletes a development resource (used to link figma design elements to external developer information like code or tasks) from a specified figma file.
Design Tokens To Tailwind
Convert design tokens to tailwind css configuration. takes the output from extractdesigntokens and generates: - tailwind.config.ts/js with theme extensions - optional globals.css with font imports note: shadow colors can be provided in either string format (e.g., "rgba(15, 110, 110, 0.32)") or dictionary format (e.g., {"r": 0.059, "g": 0.431, "b": 0.431, "a": 0.32}).
Detect Background
Detect background layers for selected nodes. uses geometric analysis, z-index ordering, and visual properties to identify potential background layers.
Discover Figma Resources
🔍 smart figma resource discovery - never guess ids again! 🎯 easiest method: just paste any figma url to get all ids: • file urls: https://www.figma.com/file/abc123/design → get file key • design urls: https://www.figma.com/design/abc123/design → get file key • node urls: ...?node-id=123:456 → get file key + node id • team urls: .../team/123456/... → get team id 🔄 step-by-step discovery: 1. team id → projects list (with project ids) 2. project id → files list (with file keys + thumbnails) 3. file key → nodes list (with node ids + hierarchy) 💡 common workflows: • extract from url: discoverfigmaresources(figma url="...") • browse team: discoverfigmaresources(team id="123") • list files: discoverfigmaresources(project id="proj 456") • find nodes: discoverfigmaresources(file key="abc123") ✨ get file key for getfilejson, node ids for detectbackground, etc.
Download Figma Images
Download images from figma file nodes. renders specified nodes as images and downloads them using mercury's filedownloadable infrastructure. supports png, svg, jpg, and pdf formats.
Extract Design Tokens
Extract design tokens from figma files. combines styles, variables, and extracted values to create a comprehensive design token system.
Extract Prototype Interactions
Extract prototype interactions and animations from figma files. analyzes the prototype data to extract: - user interactions (clicks, hovers, etc.) - transition animations - component variant states - user flows and navigation
Get Activity Logs
Retrieves activity log events from figma, allowing filtering by event types, time range, and pagination.
Get A Webhook
Retrieves detailed information about a specific webhook by its id, provided the webhook exists and is accessible to the user.
Get Comments In A File
Retrieves all comments from an existing figma file, identified by a valid `file key`, returning details like content, author, position, and reactions, with an option for markdown formatted content.
Get Component
Get component data with automatic simplification. returns clean, ai-friendly component structure.
Get Component Set
Retrieves detailed metadata for a specific published figma component set using its unique `key`.
Get Current User
Retrieves detailed information for the currently authenticated figma user.
Get Dev Resources
Retrieves development resources (e.g., jira/github links) for a figma main file, optionally filtering by specific node ids.
Get File Components
Retrieves published components from a figma file, which must be a main file (not a branch) acting as a library.
Get File Component Sets
Retrieves all published component sets from the specified figma main file (file key must not be for a branch).
Get File Json
Get figma file data with automatic simplification. this enhanced version automatically transforms verbose figma json into clean, ai-friendly format with: - css-like property names - deduplicated variables - removed empty values - 70%+ size reduction use simplify=false to get raw api response.
Get Files In A Project
Fetches a list of files in a figma project, optionally including branch metadata.
Get File Styles
Retrieves a list of published styles (like colors, text attributes, effects, and layout grids) from a specified main figma file (not a branch).
Get Image Fills
Retrieves temporary (14-day expiry) download urls for all image fills in a figma file; requires `imageref` from `paint` objects to map urls.
Get Library Analytics Component Action Data
Retrieves component insertion and detachment analytics for a specified figma library, groupable by 'component' or 'team' and filterable by a date range (yyyy-mm-dd).
Get Library Analytics Component Usage Data
Retrieves component usage analytics for a specified figma library file (identified by `file key`), with data groupable by 'component' or 'file'.
Get Library Analytics Style Action Data
Retrieves style usage analytics (insertions, detachments) for a figma library, grouped by 'style' or 'team'; if providing a date range, ensure end date is not before start date.
Get Library Analytics Style Usage Data
Retrieves style usage analytics for a figma library (specified by a valid `file key`), allowing data to be grouped by 'file' or 'style'.
Get Library Analytics Variable Action Data
Retrieves weekly, paginated analytics data on variable insertions and detachments for a specified figma library (identified by `file key`), groupable by 'variable' or 'team', and filterable by an optional date range.
Get Library Analytics Variable Usage Data
Retrieves paginated analytics data on variable usage from a specified figma library, grouped by 'file' or 'variable', for libraries with enabled analytics.
Get Local Variables
Retrieves all local/remote variables for a figma file/branch; crucial for obtaining mode-specific values which `/v1/files/{file key}/variables/published` omits.
Get Payments
Retrieves a user's payment information for a figma plugin, widget, or community file; the authenticated identity must own the resource.
Get Projects In A Team
Retrieves projects within a specified figma team that are visible to the authenticated user.
Get Published Variables
Retrieves variables published from a specified figma file; this api is available only to full members of enterprise organizations.
Get Reactions For A Comment
Retrieves reactions for a specific comment in a figma file.
Get Style
Retrieves detailed metadata for a specific style in figma using its unique style key.
Get Team Components
Retrieves components published in a specific figma team's library; the team must have published components, otherwise an empty list is returned.
Get Team Component Sets
Retrieves a paginated list of published component sets (collections of reusable ui elements) from a specified figma team's library.
Get Team Styles
Retrieves a paginated list of published styles, such as colors or text attributes, from a specified figma team's library.
Get Team Webhooks
Retrieves all webhooks registered for a specified figma team.
Get Versions Of A File
Retrieves the version history for a figma file or branch, as specified by its `file key`.
Get Webhook Requests
Retrieves a history of webhook requests for a specific figma webhook subscription; data is available for requests sent within the last seven days.
Render Images Of File Nodes
Renders specified nodes from a figma file as images (jpg, pdf, png, svg), returning a map of node ids to image urls (or `null` for failed nodes); images expire after 30 days and are capped at 32 megapixels (larger requests are scaled down).
Update A Webhook
Updates an existing figma webhook, identified by `webhook id`, allowing modification of its event type, endpoint, passcode, status, or description.
Update Dev Resources
Updates the name and/or url of one or more existing figma dev resources, each identified by its unique `id`.