Skip to main content
Penpot logo
  • Category: images & design
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 90
  • Triggers: 0
  • Slug: PENPOT
  • Version: 20261101_00

Tools

Slug: PENPOT_CREATE_ACCESS_TOKENTool to create a personal access token for API authentication in Penpot. Use when you need to generate a new token for authenticating API requests. The token will only be shown once during creation, so it should be stored securely.

Input Parameters

string
required
Descriptive name for the access token to help identify its purpose. Must be between 1 and 250 characters.
string
Optional expiration duration for the token in ISO 8601 duration format (e.g., ‘P30D’ for 30 days, ‘P90D’ for 90 days). If not provided, the token may not expire or use the default expiration policy.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_CREATE_COMMENT_THREADTool to create a new comment thread on a Penpot file at a specific position. Use when you need to add collaborative feedback or discussion points on design elements within a Penpot project.

Input Parameters

string
required
UUID of the file where the comment thread will be created
string
required
UUID of the page where the comment thread will be created
string
required
Content text of the comment thread
string
required
UUID of the frame where the comment thread will be placed. Use ‘00000000-0000-0000-0000-000000000000’ for the root frame
string
Optional UUID for shared file context
array
Optional list of user UUIDs to mention in the comment thread
string
required
Position coordinates for the comment thread in the format ‘x,y’ (e.g., ‘100,200’, ‘-50.5,100.3’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_CREATE_FILETool to create a new design file in a Penpot project. Use when you need to create a new file for design work within a specific project.

Input Parameters

string
Optional UUID to assign to the new file. If not provided, Penpot will generate one automatically.
string
required
Name of the file to create. Maximum 250 characters.
array
Set of feature flags to enable for this file.
boolean
Whether the file should be shared. Default is false.
string
required
UUID of the project where the file will be created. Must be a valid UUID format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_CREATE_PROJECTTool to create a new project within a team in Penpot. Use when you need to organize design files into a new project space.

Input Parameters

string
Optional UUID for the project. If not provided, one will be generated automatically
string
required
Name of the project to create
string
required
UUID of the team where the project will be created

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_CREATE_TEAMTool to create a new team in Penpot. Use when you need to set up a new team for organizing projects and collaborating with team members.

Input Parameters

string
UUID formatted string for the team ID (if not provided, one will be generated automatically)
string
required
Name of the team to create (maximum 250 characters)
array
Set of feature flags or permissions to enable for the team

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_CREATE_TEAM_ACCESS_REQUESTTool to request an invitation to join a Penpot team. Use when a user needs to request access to a team for collaboration.

Input Parameters

string
The UUID of the file associated with the access request.
string
required
The UUID of the team to request access to.
boolean
Flag indicating if the user is requesting viewer access (true) or editor access (false).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_CREATE_WEBHOOKCreate a webhook for a team to receive event notifications. Use when you need to register a new webhook endpoint that will be notified of events happening in a Penpot team.

Input Parameters

string
required
Webhook URI endpoint that will receive event notifications
string ("application/json" | "application/transit+json")
required
MIME type for webhook payload format
string
required
UUID of the team to create the webhook for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_DELETE_ACCESS_TOKENTool to delete a personal access token from Penpot. Use when you need to revoke or remove an existing access token by its UUID.

Input Parameters

string
required
UUID of the access token to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_DELETE_COMMENTTool to delete a comment from a Penpot design file. Use when you need to permanently remove a specific comment from a design discussion.

Input Parameters

string
required
UUID of the comment to delete
string
UUID of the share link if accessing via shared link

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_DELETE_FILE_SNAPSHOTTool to delete a file snapshot in Penpot. Use when you need to remove a previously created snapshot from a file.

Input Parameters

string
required
UUID of the file snapshot to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_DELETE_PROJECTTool to delete a project from Penpot. Use when you need to permanently remove a project and all its contents.

Input Parameters

string
required
UUID formatted string identifying the project to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_DELETE_TEAMTool to delete a team from Penpot. Use when you need to permanently remove a team. This operation is irreversible.

Input Parameters

string
required
The team identifier (UUID) to be removed

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_DELETE_TEAM_FILES_PERMANENTLYTool to permanently delete specified files from a Penpot team. Use when you need to immediately and irreversibly remove files from a team. The team ID is used to filter files and verify write permissions.

Input Parameters

array
required
List of file UUIDs to be permanently deleted from the specified team
string
required
The team identifier (UUID) to check writable permissions and filter files for deletion

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_DELETE_TEAM_INVITATIONTool to delete a pending team invitation in Penpot. Use when you need to cancel an invitation that hasn’t been accepted yet.

Input Parameters

string
required
Email address of the pending invitation to delete
string
required
The team identifier (UUID) for which to delete the invitation

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_DELETE_TEAM_MEMBERTool to remove a member from a team in Penpot. Use when you need to revoke a user’s access to a team.

Input Parameters

string
required
UUID formatted string identifying the team
string
required
UUID formatted string identifying the member to remove from the team

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_DELETE_WEBHOOKTool to delete a webhook by its UUID. Use when you need to remove a webhook from Penpot.

Input Parameters

string
required
UUID formatted string identifying the webhook to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_DUPLICATE_FILETool to duplicate a single file within the same team in Penpot. Use when you need to create a copy of an existing design file.

Input Parameters

string
Name for the duplicated file. If not provided, a default name will be generated (e.g., ‘Copy of Original File’)
string
required
UUID of the file to duplicate

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_DUPLICATE_PROJECTTool to duplicate an entire Penpot project with all its files. Use when you need to create a copy of an existing project.

Input Parameters

string
Custom name for the duplicated project. If not provided, a default name will be assigned. Maximum 250 characters.
string
required
UUID of the project to duplicate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_GET_ACCESS_TOKENSTool to list all personal access tokens for the authenticated user. Use when you need to view, audit, or manage existing access tokens.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_GET_ALL_PROJECTSRetrieve projects across Penpot teams accessible to the authenticated account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_GET_BUILTIN_TEMPLATESTool to get the list of builtin templates available in Penpot. Use when you need to see which templates are available for creating new projects.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_GET_COMMENTSTool to retrieve all comments in a comment thread. Use when you need to fetch all comments from a specific thread.

Input Parameters

string
required
UUID of the comment thread to retrieve comments from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_GET_COMMENT_THREADTool to retrieve a specific comment thread from a Penpot file. Use when you need to fetch details about a comment thread including its comments, participants, and metadata.

Input Parameters

string
required
UUID of the comment thread to retrieve
string
required
UUID of the file containing the comment thread
string
Optional UUID for shared file access

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_GET_COMMENT_THREADSTool to retrieve all comment threads for a Penpot file. Use when you need to fetch comments and discussions associated with a specific file.

Input Parameters

string
required
The UUID of the file to retrieve comment threads for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_GET_FILETool to retrieve a Penpot file by its ID. Returns file details including metadata, structure, and permissions. Use when you need to access file information or check file properties.

Input Parameters

string
required
UUID of the file to retrieve
array
Set of feature flags to enable for this request

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_GET_FILE_INFOTool to retrieve basic information about a Penpot file by its ID. Use when you need to get file metadata such as name, project, creation date, modification date, version, and sharing status.

Input Parameters

string
required
UUID of the file to retrieve information for
array
Set of feature flags to include in the response. Optional list of strings specifying which features to enable or query.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_GET_FILE_LIBRARIESTool to retrieve libraries linked to a Penpot file. Use when you need to get all library references associated with a specific file by its UUID.

Input Parameters

string
required
UUID of the file to get libraries for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_GET_FILE_OBJECT_THUMBNAILSTool to retrieve thumbnails for objects in a Penpot file. Use when you need to get thumbnail URLs for file objects.

Input Parameters

string
Optional tag to filter thumbnails (max 50 characters)
string
required
The file identifier (UUID) to retrieve object thumbnails for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_GET_FILE_SNAPSHOTSRetrieves all snapshots for a specific Penpot file. Use this action to list all saved versions (snapshots) of a file, which allows viewing version history and understanding how the file has evolved over time. Snapshots capture the state of a file at specific points in time.

Input Parameters

string
required
UUID of the Penpot file to retrieve snapshots for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_GET_FILE_SUMMARYRetrieve a high-level summary of a Penpot file, including its name and statistics for components, variants, colors, and typographies, without fetching the entire file content.

Input Parameters

string
required
UUID formatted string identifying the file

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_GET_FONT_VARIANTSTool to retrieve font variants for a team, file, project, or share in Penpot. Use when you need to get a list of available font variants. Provide at least one of team_id, file_id, project_id, or share_id to scope the query.

Input Parameters

string
UUID of the file to get font variants for
string
UUID of the team to get font variants for
string
UUID of the share to get font variants for
string
UUID of the project to get font variants for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_GET_LIBRARY_FILE_REFERENCESTool to get files that reference a shared library. Use when you need to find which files are using a specific library file in Penpot.

Input Parameters

string
required
UUID of the library file to get references for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_GET_LIBRARY_USAGETool to get usage statistics for a library. Returns the number of files that use the specified library. Use when you need to understand how widely a library is being used across projects.

Input Parameters

string
required
UUID of the library file to check usage for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_GET_OWNED_TEAMSTool to list teams owned by the current user. Use when you need to retrieve teams that the authenticated user owns in Penpot.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_GET_PAGETool to retrieve page data from a Penpot file. Use when you need to get page content including objects and metadata for rendering or export purposes. If no page ID is specified, returns the first page. Can filter to a specific object and its children by providing an object ID.

Input Parameters

string
required
UUID of the file to get the page from
string
UUID of the specific page to retrieve. If not specified, returns the first page of the file.
string
UUID of a specific object to retrieve. When specified, only that object and its children are returned. Requires pageId to be specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_GET_PROFILES_FOR_FILE_COMMENTSTool to retrieve profiles of users who have commented on a Penpot file. Use when you need to get information about comment participants for collaboration or user management purposes.

Input Parameters

string
required
UUID of the file to get comment participant profiles for
string
Optional UUID for shared file access context

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_GET_PROJECTTool to retrieve detailed information about a specific Penpot project by its ID. Use when you need to get project details such as name, team ownership, and timestamps.

Input Parameters

string
required
UUID of the project to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_GET_PROJECT_FILESTool to retrieve all files in a Penpot project. Use when you need to list all files for a specific project by its UUID.

Input Parameters

string
required
UUID of the project to get files for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_GET_SSO_PROVIDERTool to retrieve SSO provider information for an email address. Use when you need to determine which SSO provider is configured for a specific email domain.

Input Parameters

string
required
Email address to look up SSO provider configuration. Must be a valid email format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_GET_SUBSCRIPTION_USAGETool to get subscription usage information for the current user. Returns details about seats and storage usage. Use when you need to check subscription limits or current usage statistics.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_GET_TEAMTool to retrieve team details by ID. Use when you need to fetch information about a specific team in Penpot.

Input Parameters

string
required
UUID of the team to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_GET_TEAM_DELETED_FILESTool to retrieve deleted files from a team’s trash in Penpot. Use when you need to view files that have been deleted from a specific team and are in the trash.

Input Parameters

string
required
UUID of the team to retrieve deleted files from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_GET_TEAM_INFOTool to retrieve detailed information about a specific Penpot team by its ID. Use when you need to get team details such as name, creation date, and permissions.

Input Parameters

string
required
UUID of the team to retrieve information for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_GET_TEAM_INVITATIONSList pending invitations for a Penpot team. An empty list can also result from an unexpected response format.

Input Parameters

string
required
UUID formatted string identifying the team to get invitations for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_GET_TEAM_MEMBERSList members of a Penpot team and their details. An empty list can also result from an unexpected response format.

Input Parameters

string
required
UUID formatted string identifying the team to get members for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_GET_TEAMSTool to list all teams the authenticated user is a member of. Use when you need to retrieve teams where the user has membership in Penpot.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_GET_TEAM_SHARED_FILESTool to retrieve shared library files for a Penpot team. Use when you need to list all shared library files for a specific team by its UUID.

Input Parameters

string
required
UUID of the team to get shared files for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_GET_TEAM_STATSTool to retrieve statistics for a specific Penpot team by its ID. Use when you need to get team metrics such as project count, file count, and member count.

Input Parameters

string
required
UUID of the team to retrieve statistics for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_GET_TEAM_USERSRetrieve users in a Penpot team by team ID or file ID. Use this to list the team members associated with a specific team or file; at least one identifier is required.

Input Parameters

string
UUID formatted string identifying the file to get team users for. Either teamId or fileId must be provided.
string
UUID formatted string identifying the team to get users for. Either teamId or fileId must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_GET_UNREAD_COMMENT_THREADSTool to retrieve comment threads with unread comments for a specific team. Use when you need to check for new comments or discussions requiring attention.

Input Parameters

string
required
UUID of the team to retrieve unread comment threads for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_GET_VIEW_ONLY_BUNDLETool to retrieve data bundle for view-only file access in Penpot. Use when you need to access read-only file data through a share link or for preview purposes.

Input Parameters

string
required
UUID of the file to retrieve the view-only bundle for
array
Set of feature flags to enable for this request. Optional list of strings.
string
UUID of the share link associated with the view-only access. Optional.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_GET_WEBHOOKSTool to retrieve all webhooks configured for a team. Use when you need to list existing webhook endpoints registered for a Penpot team.

Input Parameters

string
required
UUID formatted string identifying the team to get webhooks for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_HAS_FILE_LIBRARIESTool to check if a Penpot file has linked libraries. Use when you need to determine whether a specific file references any external libraries.

Input Parameters

string
required
UUID of the file to check for linked libraries

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_IGNORE_FILE_LIBRARY_SYNC_STATUSTool to ignore library sync status updates for a file. Use when you need to mark library updates as ignored for a specific file, preventing sync notifications from appearing.

Input Parameters

string
required
ISO 8601 formatted timestamp indicating when to ignore library sync updates from. Must be in format YYYY-MM-DDTHH:MM:SSZ.
string
required
UUID of the file to ignore library sync status for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_LOCK_FILE_SNAPSHOTTool to lock a file snapshot in Penpot to prevent deletion. Use when you need to protect a snapshot from being removed.

Input Parameters

string
required
UUID of the file snapshot to lock

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_LOGOUTSend a logout request for the current Penpot session, optionally specifying a profile ID. The connection uses a personal access token, which must be managed separately.

Input Parameters

string
UUID of the profile to logout. If not provided, logs out the current authenticated session.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_MARK_ALL_THREADS_AS_READMark comment threads as read in Penpot using a supplied list of thread IDs.

Input Parameters

array
required
List of comment thread UUIDs to mark as read. Can be an empty list to mark all threads as read.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_MOVE_FILESTool to move files from one project to another in Penpot. Use when you need to reorganize files by transferring them between projects.

Input Parameters

array
required
List of file UUIDs to move. Must contain at least one file ID.
string
required
UUID of the destination project where files will be moved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_MOVE_PROJECTTool to move a project to a different team in Penpot. Use when you need to transfer a project from one team to another.

Input Parameters

string
required
UUID of the destination team where the project will be moved
string
required
UUID of the project to move

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_PREPARE_REGISTER_PROFILETool to prepare user registration by validating email and sending verification in Penpot. Use when you need to initiate the registration process for a new user. This endpoint validates the provided information and typically sends a verification email to complete the registration.

Input Parameters

string
required
Email address for the new user account. Must be a valid email format.
string
required
Full name of the user to register. Must be a non-whitespace string.
string
required
Password for the new user account. Should meet security requirements.
string
Optional invitation token for team access. Include this if registering with a team invitation.
boolean
Optional flag to automatically create a welcome file for the new user. If not specified, uses system default.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_PUSH_AUDIT_EVENTSTool to push audit events to Penpot for tracking system behavior and user actions. Use when you need to log important events like user actions, file changes, or team modifications for auditing purposes.

Input Parameters

array
required
Array of audit events to push (must contain at least one event)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_REGISTER_PROFILETool to complete user registration with profile details using a verification token. Use when you have a registration token from the prepare-register-profile endpoint and need to finalize the user account creation.

Input Parameters

string
required
Registration token received from the prepare-register-profile endpoint, typically sent via email verification. This JWT token contains the encrypted registration data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_RENAME_FILETool to rename a design file in Penpot. Use when you need to change the name of an existing file.

Input Parameters

string
required
UUID of the file to rename
string
required
New name for the file (1-250 characters)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_RENAME_PROJECTTool to rename an existing project in Penpot. Use when you need to update a project’s name.

Input Parameters

string
required
UUID of the project to rename
string
required
New name for the project

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_REQUEST_PROFILE_RECOVERYTool to request a password/profile recovery email. Use when a user has forgotten their password and needs to initiate the account recovery process. An email with a recovery token will be sent to the specified address.

Input Parameters

string
required
Email address of the user account to recover. A recovery email will be sent to this address with a token to reset the password.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_RESTORE_DELETED_TEAM_FILESTool to restore deleted files in a Penpot team. Use when you need to remove the deletion mark from files and projects that are in the team’s trash.

Input Parameters

array
required
List of file UUIDs to restore from deletion. Each file will have its deletion mark removed along with its respective project.
string
required
UUID of the team containing the deleted files to restore

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_RESTORE_FILE_SNAPSHOTTool to restore a Penpot file to a previous snapshot. Use when you need to revert a file to a previously saved version from its history.

Input Parameters

string
required
UUID of the snapshot to restore to
string
required
UUID of the Penpot file to restore

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_SEARCH_FILESTool to search for files by name or content in a Penpot team. Use when you need to find specific files within a team using a search term.

Input Parameters

string
required
UUID of the team to search files in
string
Search term to filter files by name or content. If not provided, returns all files in the team.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_SEND_USER_FEEDBACKTool to send user feedback to Penpot. Use when you need to submit feedback, bug reports, feature requests, or error reports to the Penpot team.

Input Parameters

string
Type or category of the feedback
string
required
Detailed content of the feedback message (maximum 2500 characters)
string
required
Subject line for the feedback (maximum 500 characters)
string
URL or link associated with an error, if the feedback is related to a specific page or error (maximum 2500 characters)
string
Detailed error report or stack trace if the feedback is related to an error

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_SET_FILE_SHAREDTool to set file sharing status in Penpot (enable/disable shared library). Use when you need to make a file available as a shared library or revoke its shared status.

Input Parameters

string
required
UUID of the file to update the sharing status for
boolean
required
Whether the file should be shared as a library. Set to true to enable sharing, false to disable.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_UNLOCK_FILE_SNAPSHOTTool to unlock a locked file snapshot in Penpot. Use when you need to unlock a previously locked snapshot.

Input Parameters

string
required
UUID of the file snapshot to unlock

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_UPDATE_COMMENTTool to update the content of an existing comment in a Penpot design file. Use when you need to modify comment text or update mentioned users in a design discussion.

Input Parameters

string
required
UUID of the comment to update
string
required
New content text for the comment
string
Optional UUID of the share link if accessing via shared link
array
Optional list of user UUIDs to mention in the updated comment

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_UPDATE_COMMENT_THREADTool to update the resolution status of a comment thread in Penpot. Use when you need to mark a comment thread as resolved or unresolved to track discussion progress.

Input Parameters

string
required
UUID of the comment thread to update
string
Optional UUID for shared file context
boolean
required
Whether the comment thread should be marked as resolved

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_UPDATE_COMMENT_THREAD_FRAMETool to update the frame associated with a comment thread in Penpot. Use when you need to move a comment thread to a different frame or reposition it within the design hierarchy.

Input Parameters

string
required
UUID of the comment thread to update
string
required
UUID of the frame to associate with the comment thread. Use ‘00000000-0000-0000-0000-000000000000’ for the root frame
string
Optional UUID for shared file context

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_UPDATE_COMMENT_THREAD_POSITIONUpdate the position of an existing Penpot comment thread on the design canvas. Provide its new coordinates and containing frame, with an optional shared-file context.

Input Parameters

string
required
UUID of the comment thread to update
string
required
UUID of the frame containing the comment thread. Use ‘00000000-0000-0000-0000-000000000000’ for the root frame
string
Optional UUID for shared file context
string
required
New position coordinates for the comment thread in the format ‘x,y’ (e.g., ‘150,250’, ‘-50.5,100.3’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_UPDATE_COMMENT_THREAD_STATUSTool to update the status of a comment thread in Penpot (e.g., toggle resolved/unresolved). Use when you need to mark a comment thread as resolved or reopen a resolved thread.

Input Parameters

string
required
UUID of the comment thread to update status for
string
UUID of the share link if accessing via shared link

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_UPDATE_FILETool to update a Penpot file with changes. Use when you need to apply modifications to a file such as adding/modifying/deleting objects, pages, colors, components, or other design elements. Requires file ID, session ID, revision number, and version number for optimistic locking.

Input Parameters

string
required
UUID of the file to update. Must be a valid UUID format.
integer
required
Revision number of the file. Used for optimistic locking to prevent conflicts.
integer
required
Version number of the file. Used for tracking file version history.
array
Array of change objects to apply to the file. Each change object must have a ‘type’ field and additional fields based on the change type (e.g., AddObjChange, ModObjChange, DelObjChange, AddPageChange, etc.).
array
Set of feature flags to enable for this update operation.
string
required
UUID of the session. Must be a valid UUID format.
boolean
Whether to skip validation of changes. Use with caution as invalid changes may corrupt the file.
array
Array of change groups with metadata including hint events and origin information.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_UPDATE_FILE_LIBRARY_SYNC_STATUSTool to update the synchronization status of a file->library link. Use when you need to refresh or update the sync status between a file and its linked library.

Input Parameters

string
required
UUID of the file to update library sync status for
string
required
UUID of the library to update sync status with

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_UPDATE_FILE_SNAPSHOTTool to update a file snapshot metadata in Penpot. Use when you need to modify the label of an existing snapshot.

Input Parameters

string
required
UUID of the file snapshot to update
string
required
Updated label for the snapshot (must be a non-whitespace string)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_UPDATE_FONTUpdate the name of an existing font in a Penpot team.

Input Parameters

string
required
UUID of the font to update
string
required
Updated name for the font (1-250 characters)
string
required
UUID of the team that owns the font

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_UPDATE_PROFILETool to update the current authenticated user’s profile information. Use when you need to change the user’s full name, language preference, or theme settings.

Input Parameters

string
Language preference code (maximum 8 characters, e.g., ‘en’, ‘es’, ‘fr’)
string
Theme preference for the user interface (maximum 250 characters)
string
required
Full name of the user

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_UPDATE_PROFILE_NOTIFICATIONSTool to update notification settings for the authenticated user’s profile. Use when you need to configure how the user receives notifications about comments and invitations.

Input Parameters

string ("all" | "none")
required
Notification setting for email invites. Controls whether the user receives email notifications about team or project invitations.
string ("all" | "partial" | "none")
required
Notification setting for email comments. Controls whether the user receives email notifications about comments.
string ("all" | "partial" | "none")
required
Notification setting for dashboard comments. Controls whether the user receives notifications about comments on the dashboard.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_UPDATE_PROFILE_PROPSTool to update custom properties for the authenticated user’s profile. Use when you need to modify user preferences such as onboarding status, notification settings, newsletter subscriptions, or plugin configurations.

Input Parameters

object
required
Custom properties to update for the user profile

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_UPDATE_PROJECT_PINUpdate a Penpot project’s pin status to pin or unpin it for quick access. Identify the project and its owning team and specify the desired pin status.

Input Parameters

string
required
UUID of the project to update
string
required
UUID of the team that owns the project
boolean
required
Whether the project should be pinned (true) or unpinned (false)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_UPDATE_TEAMUpdate the name of a Penpot team by its ID.

Input Parameters

string
required
UUID of the team to update
string
required
Updated name for the team (maximum 250 characters)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_UPDATE_TEAM_INVITATION_ROLETool to update the role of a pending team invitation in Penpot. Use when you need to change the role of an invitation that hasn’t been accepted yet.

Input Parameters

string ("viewer" | "admin" | "editor" | "owner")
required
New role to assign to the pending invitation
string
required
Email address of the pending invitation to update
string
required
The team identifier (UUID) for which to update the invitation role

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_UPDATE_WEBHOOKUpdate an existing webhook configuration by supplying its URI, MIME type, and active status together.

Input Parameters

string
required
UUID of the webhook to update
string
required
Webhook URI endpoint that will receive event notifications
string ("application/json" | "application/transit+json")
required
MIME type for webhook payload format
boolean
required
Whether the webhook should be active or inactive

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PENPOT_VERIFY_TOKENVerify a Penpot authentication or registration token, such as one received during registration or email verification. Returns a verification result and may include associated user or token details.

Input Parameters

string
required
Authentication or registration token to verify. This can be a verification token from registration, email change, or other authentication flows. Maximum length of 5000 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not