Figma Modules

With the Adobe Workfront Fusion Figma modules, you can retrieve lists of comments, files, file versions, or projects. You can also post a comment or make a call to the Figma API.

If you need instructions on creating a scenario, see Create a scenario.

For information about modules, see Modules in Adobe Workfront Fusion.

Access requirements

You must have the following access to use the functionality in this article:

Adobe Workfront plan*

Pro or higher
Adobe Workfront license*

Plan, Work
Adobe Workfront Fusion license**

Workfront Fusion for Work Automation and Integration
Product Your organization must purchase Adobe Workfront Fusion as well as Adobe Workfront to use functionality described in this article.

To find out what plan, license type, or access you have, contact your Workfront administrator.

For information on Adobe Workfront Fusion licenses, see Adobe Workfront Fusion licenses.

Prerequisites

To use Figma modules, you must have a Figma account.

Figma modules and their fields

When you configure Figma modules, Workfront Fusion displays the fields listed below. Along with these, additional Figma fields might display, depending on factors such as your access level in the app or service. A bolded title in a module indicates a required field.

If you see the map button above a field or function, you can use it to set variables and functions for that field. For more information, see Map information from one module to another in Adobe Workfront Fusion.

Comments

Delete a comment

This action module deletes a single comment from a file.

Connection

For instructions about connecting your Figma account to Workfront Fusion, see Create a connection to Adobe Workfront Fusion - Basic instructions.
File ID Enter or map the File ID of the file that you want to add a delete a comment from.
Comment Enter the text of the comment you want to delete.

List comments

This search module lists all of the comments attached to a single file in Figma.

Connection

For instructions about connecting your Figma account to Workfront Fusion, see Create a connection to Adobe Workfront Fusion - Basic instructions.

File ID

Enter or map the File ID of the file that you want to retrieve comments for.

  • If you do not know the ID, click Find Files and enter or map the ID of the project that the file is associated with, then select the file.

  • If you do not know the project's ID, click Find Projects and enter or map the ID of the team that owns the project the file is associated with, then select the project, then select the file.
Limit Enter or map the maximum number of comments you want the module to return during each scenario execution cycle.

Post a comment

This action module posts a comment to a Figma file.

Connection

For instructions about connecting your Figma account to Workfront Fusion, see Create a connection to Adobe Workfront Fusion - Basic instructions.

File ID

Enter or map the File ID of the file that you want to post a comment to.

  • If you do not know the file's ID, click Find Files and enter or map the ID of the project that the file is associated with, then select the file.

  • If you are attempting to find the file's ID and do not know the project's ID, click Find Projects and enter or map the ID of the team that owns the project the file is associated with. Select the project, then select the file.
Comment Enter the text of the comment.

Projects and files

Get a file or image

This action module retrieves a single file or image from a Figma library

Connection

For instructions about connecting your Figma account to Workfront Fusion, see Create a connection to Adobe Workfront Fusion - Basic instructions.

Object type

Select the type of object you want to retrieve.

  • File

    The module returns the document referred to by Key as a JSON object. The file key can be parsed from any Figma file URL.

    For fields, see Get a file or image: File.

  • File nodes

    Returns the nodes referenced to by IDs as a JSON object. The nodes are retrieved from the Figma file referenced to by Key.

    For fields, see Get a file or image: File nodes.

  • Image

    The module renders images from a file.

    For fields, see Get a file or image: Image.

  • Image fills

    The module returns download links for all images present in image fills in a document. Image fills are how Figma represents any user-supplied images. When you drag an image into Figma, Figma creates a rectangle with a single fill that represents the image, and the user is able to transform the rectangle (and properties on the fill).

    For fields, see Get a file or image: Image fills.
Get a file or image: File
File key Select the file that you want to return JSON from.
Version ID Enter or map the version of the file you want the module to return. For the current module, leave this field blank.
Node IDs

To return only a subset of the document, enter the nodes that you want the module to return. The module returns the listed nodes, their children, and anything between the root node and the listed nodes.

For each node that you want to return, click Add and enter the text of the node.
Depth

Enter or map an integer that represents how deep into the document tree you want to return results for.

Example:

  • To return pages only, enter 1.

  • To return pages and top level objects, enter 2.

To return all nodes, leave this field blank.
Geometry To return vector data, enter paths.
Plugin data A comma separated list of plugin IDs and/or the string "shared". Any data present in the document written by those plugins will be included in the result in the pluginData and sharedPluginData properties.
Branch data Enable this option to return branch metadata for the requested file. If the file is a branch, the main file's key is included in the returned response. If the file has branches, their metadata is included in the returned response. Default: false.
Get a file or image: File nodes
File key Select the file that you want to return JSON from.
Node IDs

Enter the nodes that you want the module to return and convert

For each node that you want to return, click Add and enter the text of the node.
Version ID Enter or map the version of the file you want the module to return. For the current module, leave this field blank.
Depth

Enter or map an integer that represents how deep into the document tree you want to return results for.

Example:

  • To return pages only, enter 1.

  • To return pages and top level objects, enter 2.

To return all nodes, leave this field blank.
Geometry To return vector data, enter paths.
Plugin data A comma separated list of plugin IDs and/or the string "shared". Any data present in the document written by those plugins will be included in the result in the pluginData and sharedPluginData properties.
Get a file or image: Image
File key Select the file that you want to return JSON from.
Node IDs

Enter the nodes that you want the module to render.

For each node that you want to render, click Add and enter the text of the node.
Scale To scale the image, enter or map the scaling factor. This number must be between 0.01 and 4.
Format

Select the format for the image output.

  • JPG

  • PNG

  • SVG

  • PDF
SVG - Include ID Enable this option to include ID attributes for all SVG elements. Default: false.
SVG - Simplify Stroke Enable this option to simplify inside/outside strokes and use stroke attribute if possible instead of <mask>. Default: true.
Use absolute bounds Enable this option to use the full dimensions of the node regardless of whether or not it is cropped or the space around it is empty. Use this to export text nodes without cropping. Default: false.
Version ID Enter or map the version of the file you want the module to return. For the current module, leave this field blank.
Get a file or image: Image fills
File key Select the file that you want to return JSON from.

List file version history

This search module returns the version history of a single file in Figma.

Connection

For instructions about connecting your Figma account to Workfront Fusion, see Create a connection to Adobe Workfront Fusion - Basic instructions.

File ID

Enter or map the File ID of the file that you want retrieve version history for.

  • If you do not know the file's ID, click Find Files and enter or map the ID of the project that the file is associated with, then select the file.

  • If you are attempting to find the file's ID and do not know the project's ID, click Find Projects and enter or map the ID of the team that owns the project the file is associated with. Select the project, then select the file.
Limit Enter or map the maximum number of records you want the module to return during each scenario execution cycle.

List project files

This search module returns a list of all files in the specified project.

Connection

For instructions about connecting your Figma account to Workfront Fusion, see Create a connection to Adobe Workfront Fusion - Basic instructions.

File ID

Enter or map the Project ID the project that you want retrieve files for.

  • If you do not know the projects's ID, click Find Projects and enter or map the ID of the team that the project is are associated with, then select the project.
Limit Enter or map the maximum number of records you want the module to return during each scenario execution cycle.

List projects

This search module returns a list of all projects within the specified team.

Connection

For instructions about connecting your Figma account to Workfront Fusion, see Create a connection to Adobe Workfront Fusion - Basic instructions.

Team ID Enter or map the Project ID of the project that you want to retrieve files for. The team ID can be found in the URL of the team's page in Figma
Limit Enter or map the maximum number of records you want the module to return during each scenario execution cycle.

Components and styles

Get a style or component

This action module retrieves a single style or component, or a set of styles or components.

Connection

For instructions about connecting your Figma account to Workfront Fusion, see Create a connection to Adobe Workfront Fusion - Basic instructions.

<Object> key Enter the key (unique identifier) of the object you want to retrieve.
Team ID Enter or map the ID of the team that the record or records are associated with.
Page Size Enter or map the number or results to return per page. Default: 30.
After

Enter or map the number of the result after which to start retrieving results. This can be combined with the Page Size field to paginate results.

This value does not correspond to object IDs.

This field cannot be used in combination with the Before field.
Before

Enter or map the number of the result before which to start retrieving results. This can be combined with the Page Size field to paginate results.

This value does not correspond to object IDs.

This field cannot be used in combination with the After field.

Other

Make an API call

This action module lets you make a custom authenticated call to the Figma API without having to think through authentication. This way, you can create a data flow automation that can’t be accomplished by the other Figma modules.

Connection

For instructions about connecting your Figma account to Workfront Fusion, see Create a connection to Adobe Workfront Fusion - Basic instructions.

URL

Enter a path relative to https://api.figma.com/v1/.

For example: files/7179110/comments
Method

Select the HTTP request method you need to configure the API call. For more information, see HTTP request methods in Adobe Workfront Fusion.
Headers

Add the headers of the request in the form of a standard JSON object.

For example, {"Content-type":"application/json"}

Workfront Fusion adds the authorization headers for you.
Query String

Add the query for the API call in the form of a standard JSON object.

For example: {"name":"something-urgent"}
Body

Add the body content for the API call in the form of a standard JSON object.

Note:

When using conditional statements such as if in your JSON, put the quotation marks outside of the conditional statement.

Watch events

This trigger module starts a scenario when one of the following events occur for a specific team in your Figma team space

  • File update

  • File version update

  • File delete

  • Library publish

  • File comment

Webhook

Select the webhook that the module watches.

To add a new webhook:

  1. Click Add next to the Webhook field.

  2. Select the connection you want to use for this webhook. For instructions about connecting your Figma account to Workfront Fusion, see Create a connection to Adobe Workfront Fusion - Basic instructions.

  3. Select the event type that you want the module to watch.

  4. Enter the ID of the team whose events you want the webhook to watch.

  5. Enter the Status or Description of events that you want the webhook to watch.

  6. Click Save to save the webhook and return to the module.

On this page