Team
Shared credential for production and unattended runs.
Connect Penpot with Hookshot™ and your stack
Open-source design and prototyping platform for collaborative design workflows
Tools and triggers
What Agents can do in Penpot
Available tools and events after Penpot is connected.
-
Create Access Token
Tool 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…
-
Create Comment Thread
Tool 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.
-
Create File
Tool 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.
-
Create Project
Tool to create a new project within a team in Penpot. Use when you need to organize design files into a new project space.
-
Create Team
Tool 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.
-
Create Team Access Request
Tool to request an invitation to join a Penpot team. Use when a user needs to request access to a team for collaboration.
-
Create Webhook
Create 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.
-
Delete Access Token
Tool to delete a personal access token from Penpot. Use when you need to revoke or remove an existing access token by its UUID.
-
Delete Comment
Tool to delete a comment from a Penpot design file. Use when you need to permanently remove a specific comment from a design discussion.
-
Delete File Snapshot
Tool to delete a file snapshot in Penpot. Use when you need to remove a previously created snapshot from a file.
-
Delete Project
Tool to delete a project from Penpot. Use when you need to permanently remove a project and all its contents.
-
Delete Team
Tool to delete a team from Penpot. Use when you need to permanently remove a team. This operation is irreversible.
-
Delete Team Invitation
Tool to delete a pending team invitation in Penpot. Use when you need to cancel an invitation that hasn't been accepted yet.
-
Delete Team Member
Tool to remove a member from a team in Penpot. Use when you need to revoke a user's access to a team.
-
Delete Webhook
Tool to delete a webhook by its UUID. Use when you need to remove a webhook from Penpot.
-
Duplicate File
Tool to duplicate a single file within the same team in Penpot. Use when you need to create a copy of an existing design file.
-
Duplicate Project
Tool to duplicate an entire Penpot project with all its files. Use when you need to create a copy of an existing project.
-
Get Access Tokens
Tool to list all personal access tokens for the authenticated user. Use when you need to view, audit, or manage existing access tokens.
-
Get All Projects
Tool to retrieve all projects across all teams in Penpot. Use when you need a complete list of projects regardless of team membership.
-
Get Builtin Templates
Tool to get the list of builtin templates available in Penpot. Use when you need to see which templates are available for creating new projects.
-
Get Comment Thread
Tool 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.
-
Get Comment Threads
Tool to retrieve all comment threads for a Penpot file. Use when you need to fetch comments and discussions associated with a specific file.
-
Get Comments
Tool to retrieve all comments in a comment thread. Use when you need to fetch all comments from a specific thread.
-
Get File
Tool 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.
-
Get File Info
Tool 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.
-
Get File Libraries
Tool 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.
-
Get File Object Thumbnails
Tool to retrieve thumbnails for objects in a Penpot file. Use when you need to get thumbnail URLs for file objects.
-
Get File Snapshots
Retrieves 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…
-
Get File Summary
Tool to retrieve a summary of file contents and statistics from Penpot. Use when you need high-level information about a file including page count, components, graphics, and other metadata without fetching the entire…
-
Get Font Variants
Tool 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…
-
Get Library File References
Tool to get files that reference a shared library. Use when you need to find which files are using a specific library file in Penpot.
-
Get Library Usage
Tool 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.
-
Get Owned Teams
Tool to list teams owned by the current user. Use when you need to retrieve teams that the authenticated user owns in Penpot.
-
Get Page
Tool 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…
-
Get Profiles for File Comments
Tool 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.
-
Get Project
Tool 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.
-
Get Project Files
Tool to retrieve all files in a Penpot project. Use when you need to list all files for a specific project by its UUID.
-
Get SSO Provider
Tool 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.
-
Get Subscription Usage
Tool 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.
-
Get Team
Tool to retrieve team details by ID. Use when you need to fetch information about a specific team in Penpot.
-
Get Team Deleted Files
Tool 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.
-
Get Team Info
Tool 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.
-
Get Team Invitations
Tool to list pending invitations for a team in Penpot. Use when you need to retrieve all pending team invitations that haven't been accepted yet.
-
Get Team Members
Tool to list all members of a team in Penpot. Use when you need to retrieve team membership information and member details.
-
Get Team Shared Files
Tool 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.
-
Get Team Stats
Tool 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.
-
Get Team Users
Tool to retrieve users in a team by team ID or file ID. Use when you need to list team members associated with a specific team or file.
-
Get Teams
Tool 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.
-
Get Unread Comment Threads
Tool to retrieve comment threads with unread comments for a specific team. Use when you need to check for new comments or discussions requiring attention.
-
Get View Only Bundle
Tool 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.
-
Get Webhooks
Tool to retrieve all webhooks configured for a team. Use when you need to list existing webhook endpoints registered for a Penpot team.
-
Has File Libraries
Tool to check if a Penpot file has linked libraries. Use when you need to determine whether a specific file references any external libraries.
-
Ignore File Library Sync Status
Tool 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.
-
Link File to Library
Tool to link a file to a library in Penpot. Returns the recursive list of libraries used by that library. Use when you need to establish a library reference relationship between a file and a library.
-
Lock File Snapshot
Tool to lock a file snapshot in Penpot to prevent deletion. Use when you need to protect a snapshot from being removed.
-
Logout
Tool to clear the authentication cookie and logout the current session. Use when the authenticated user wants to end their Penpot session and invalidate their authentication.
-
Mark All Threads as Read
Tool to mark all comment threads as read in Penpot. Use when you need to clear unread status for comment threads.
-
Move Files
Tool to move files from one project to another in Penpot. Use when you need to reorganize files by transferring them between projects.
-
Move Project
Tool to move a project to a different team in Penpot. Use when you need to transfer a project from one team to another.
-
Permanently Delete Team Files
Tool 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.
-
Prepare Register Profile
Tool 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…
-
Push Audit Events
Tool 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.
-
Register Profile
Tool 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.
-
Rename File
Tool to rename a design file in Penpot. Use when you need to change the name of an existing file.
-
Rename Project
Tool to rename an existing project in Penpot. Use when you need to update a project's name.
-
Request Profile Recovery
Tool 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.
-
Restore Deleted Team Files
Tool 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.
-
Restore File Snapshot
Tool 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.
-
Search Files
Tool 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.
-
Send User Feedback
Tool to send user feedback to Penpot. Use when you need to submit feedback, bug reports, feature requests, or error reports to the Penpot team.
-
Set File Shared
Tool 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.
-
Unlink File From Library
Tool to unlink a file from a shared library in Penpot. Use when you need to remove the library reference relationship between a file and a library.
-
Unlock File Snapshot
Tool to unlock a locked file snapshot in Penpot. Use when you need to unlock a previously locked snapshot.
-
Update Comment
Tool 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.
-
Update Comment Thread
Tool 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.
-
Update Comment Thread Frame
Tool 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.
-
Update Comment Thread Position
Tool to update the position of a comment thread in Penpot. Use when you need to move or reposition an existing comment thread to a different location on the design canvas.
-
Update Comment Thread Status
Tool 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.
-
Update File
Tool 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…
-
Update File Library Sync Status
Tool 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.
-
Update File Snapshot
Tool to update a file snapshot metadata in Penpot. Use when you need to modify the label of an existing snapshot.
-
Update Font
Tool to update a font's metadata in Penpot. Use when you need to modify the name or other properties of an existing font in a team.
-
Update Profile
Tool 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.
-
Update Profile Notifications
Tool 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.
-
Update Profile Props
Tool 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.
-
Update Project Pin
Tool to update the pin status of a project in Penpot. Use when you need to pin or unpin a project for quick access.
-
Update Team
Tool to update team settings in Penpot. Use when you need to modify team name or other team properties.
-
Update Team Invitation Role
Tool 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.
-
Update Webhook
Tool to update an existing webhook configuration. Use when you need to modify the URI, MIME type, or active status of a webhook.
-
Verify Token
Tool to verify an authentication or registration token in Penpot. Use when you need to validate a token received from registration, email verification, or other authentication flows.
Setup
Connect Penpot in Hookshot™
Pick a scope, then confirm what can start a Protege and what it can do.
Trigger Access
What can start a Protege from this app.
Tool Access
What a Protege can do after it starts.
Connection scope
Prefer team for production.
Personal
Tied to one user—only when the workflow needs their account.
Chat
Team-scoped for supported chat surfaces.
Build with us
See Hookshot™ in your stack.
Request early access or book a live walkthrough with the team.
