Figma

Getting Started with Figma

The Figma modules allow you to post comments, list comments, file version history, project files and projects in your Figma account.

Prerequisites

  • A Figma account

In order to use Figma with Make, it is necessary to have a Figma account. If you do not have one, you can create a Figma account at www.figma.com.

Note

The module dialog fields that are displayed in bold (in the Make scenario, not in this documentation article) are mandatory!

Connecting Figma to Make

To connect your Figma account to Make follow the general instructions for Connecting to services.

After you click the Continue button, Make will redirect you to the Figma website where you will be prompted to grant Make access to your account.

61f26cc7adeaf.png

Confirm the dialog by clicking the Allow Access button.

Actions

Adds a comment to a specified file.

Connection

Establish a connection to your Figma account.

File ID

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

You can retrieve the ID using the Find Files button. You have to enter the Team ID or Project ID.

The Team ID can be found in the URL:

61f26cc8d8135.png

Enter the File ID using the Find buttons:

61f26cca33bf0.gif

Comment

Enter the text of the comment.

Allows you to perform a custom API call.

Connection

Establish a connection to your Figma account.

URL

Enter a path relative to https://api.figma.com/v1/. E.g. teams/734015537730895277/projects

Where 734015537730895277 is,replace with the desired Team ID.

Note

For the list of available endpoints, refer to the Figma developer documentation.

Method

Select the HTTP method you want to use:

GET

to retrieve information for an entry.

POST

to create a new entry.

PUT

to update/replace an existing entry.

PATCH

to make a partial entry update.

DELETE

to delete an entry.

Headers

Enter the desired request headers. You don't have to add authorization headers; we already did that for you.

Query String

Enter the request query string.

Body

Enter the body content for your API call.

The following API call returns all of the team's projects:

61f26ccd3f1c5.png

Matches of the search can be found in the module's Output under Bundle > Body > projects.

In our example, 2 projects were returned:

61f26cce8e6a1.png

Searches

Retrieves all comments on the file.

Connection

Establish a connection to your Figma account.

File ID

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

You can retrieve the ID using the Find Files button. You have to enter the Team ID or Project ID.

The Team ID can be found in the URL:

61f26ccfca28a.png

Enter the File ID using the Find buttons:

61f26cca33bf0.gif

Limit

Set the maximum number of comments Make will return during one execution cycle.

Lists the version history of a file.

Connection

Establish a connection to your Figma account.

File ID

Enter or map the File ID of the file you want to retrieve the version history from.

You can retrieve the ID using the Find Files button. You have to enter the Team ID or Project ID.

The Team ID can be found in the URL:

61f26ccfca28a.png

Entering the File ID using the Find buttons:

61f26cca33bf0.gif

Limit

Set the maximum number of version history records Make will return during one execution cycle.

Lists the files in a specified project.

Connection

Establish a connection to your Figma account.

File ID

Enter or map the Project ID of the project you want to retrieve the project files from.

You can retrieve the ID using the Find Files button. You need just the Team ID to get the Project ID.

The Team ID can be found in the URL:

61f26ccfca28a.png

Enter the Project ID using the Find buttons:

61f26cca33bf0.gif

Limit

Set the maximum number of project files Make will return during one execution cycle.

Retrieves a list of all the projects within a specified team.

Connection

Establish a connection to your Figma account.

Team ID

Enter or map the Team ID of the team you want to retrieve projects from.

To obtain a Team ID, navigate to a team page of a team you are a part of. The Team ID will be present in the URL after the word "team" and before your team name:

61f26ccfca28a.png

Limit

Set the maximum number of projects Make will return during one execution cycle.