Team
Shared credential for production and unattended runs.
Connect Outline with Hookshot™ and your stack
Team knowledge base and wiki for managing documentation and collaboration
Tools and triggers
What Agents can do in Outline
Available tools and events after Outline is connected.
-
Activate User
Tool to activate a previously suspended user in Outline. Activating a user allows them to sign in again and will cause billing totals to be re-calculated in the hosted version. Use when you need to restore access for a…
-
Add Document User
Tool to add a user membership to a document. Use when you need to grant a user access to a specific document.
-
Add Group to Collection
Tool to add a group to a collection in Outline. Use when you need to grant all members of a group access to a specific collection with read or write permissions.
-
Add Group to Document
Tool to give all members in a group access to a document. Use when you need to grant document-level access permissions to an entire group at once, rather than adding individual users one by one.
-
Add User to Collection
Tool to add a user to a collection with specified permissions. Use when you need to grant a user access to a specific collection.
-
Add User to Group
Tool to add a user to a group. Use when you need to grant a user membership in a specific group.
-
Archive Document
Tool to archive a document in Outline. Use when you need to move outdated information out of sight while retaining the ability to search and restore it later.
-
Create Attachment
Tool to create an attachment in Outline. This creates a database record and returns the inputs needed to generate a signed URL and upload the file from the client to cloud storage. Use when you need to prepare an…
-
Create Collection
Tool to create a new collection in Outline. Use when you need to organize documents by creating a new collection with a specific name, description, icon, color, and permission settings.
-
Create Comment
Tool to create a comment on an Outline document. Use when you need to add a comment or reply to a document. Either text or data field is required for the comment body.
-
Create Document
Tool to create a new document in Outline. Use when you need to create a new document with specified title, content, and metadata. Documents can be created as drafts or immediately published to a collection. At least…
-
Create Group
Tool to create a new group in Outline. Use when you need to organize users into logical groups for easier permission management across collections.
-
Create OAuth Client
Tool to create a new OAuth client in Outline. Use when you need to create an OAuth client application that can be used to authenticate users and access the API on their behalf.
-
Create Share
Tool to create a public share link for an Outline document. Use when you need to generate a shareable URL that allows access without workspace membership. If you request multiple shares for the same document with the…
-
Create Star
Tool to create a star for a document or collection in Outline. Use when you need to star (favorite) a document or collection so it appears in the user's sidebar. One of either documentId or collectionId must be provided.
-
Create Template
Tool to create a new template in Outline. Use when you need to create a reusable template that can be used as a starting point for new documents. Templates can optionally be scoped to a specific collection.
-
Create Template From Document
Tool to create a template from an existing Outline document. Use when you need to convert a document into a reusable template for your workspace.
-
Create View
Tool to create a view for a document. Use when you need to record that a document has been viewed. Note: It is recommended that views are not created from outside of the Outline UI.
-
Delete Attachment
Tool to delete an attachment from Outline. Deleting an attachment is permanent. It will not delete references or links to the attachment that may exist in your documents.
-
Delete Collection
Tool to delete a collection and all of its documents from Outline. Use when you need to permanently remove a collection. This action cannot be undone, so use with caution.
-
Delete Comment
Tool to delete a comment in Outline. Use when you need to remove a comment from a document. If the comment is a top-level comment, all its children will be deleted as well.
-
Delete Document
Tool to delete a document in Outline. Deleting a document moves it to the trash by default. If not restored within 30 days it is permanently deleted. Use permanent=true to destroy the document immediately with no way…
-
Delete File Operation
Tool to delete a file operation and its associated files from Outline. Use when you need to clean up completed or failed import/export operations.
-
Delete Group
Tool to delete a group from Outline. Deleting a group will cause all of its members to lose access to any collections the group has previously been added to. This action cannot be undone, so use with caution.
-
Delete OAuth Authentication
Tool to delete an OAuth authentication in Outline. Use when you need to revoke a third-party application's access to a user's account. This action removes the OAuth authentication connection between Outline and the…
-
Delete OAuth Client
Tool to delete an OAuth client from Outline. Permanently delete an OAuth client and revoke all associated access tokens. This action cannot be undone, so use with caution.
-
Delete Star
Tool to delete a star from a document in Outline. Use when you need to remove a star from a user's starred documents list.
-
Delete Template
Tool to delete a template in Outline. This will soft-delete the template, it can be restored later. Use when you need to remove a template from the workspace.
-
Delete User
Tool to delete a user in Outline. Deleting a user removes the object entirely. In almost every circumstance it is preferable to suspend a user, as a deleted user can be recreated by signing in with SSO again. Use when…
-
Duplicate Document
Tool to duplicate an Outline document. Use when you need to create a copy of an existing document, optionally including all child documents in the hierarchy.
-
Duplicate Template
Tool to duplicate an Outline template. Use when you need to create a copy of an existing template, optionally with a new title or in a different collection.
-
Empty Documents Trash
Tool to permanently delete all documents in the trash. Use when you need to empty the trash and remove all trashed documents permanently. WARNING: This action is irreversible and only available to admin users.
-
Export All Collections
Tool to export all collections and their documents in bulk. Use when you need to create a backup or export of all workspace collections. Returns a FileOperation object for tracking export progress.
-
Export Collection
Tool to export a collection in markdown, JSON, or HTML format. Triggers a bulk export that includes all documents and attachments. If documents are nested, they will be organized in folders within the zip file. Returns…
-
Export Document
Tool to export a document from Outline in Markdown, HTML, or PDF format. The response format is determined by the Accept header (text/markdown, text/html, or application/pdf). Use when you need to download or extract…
-
Get Attachment Redirect URL
Tool to retrieve an attachment redirect URL from Outline. Loads an attachment from where it is stored based on the id. If the attachment is private, a temporary signed URL with embedded credentials is generated on…
-
Get Authentication Config
Tool to retrieve authentication configuration options for an Outline workspace. Use when you need to discover the workspace name, hostname, or available SSO/OAuth authentication services before user login.
-
Get Collection Documents
Tool to retrieve a collection's document structure as a tree of navigation nodes. Use when you need to explore the document hierarchy within a collection.
-
Get Collection Info
Tool to retrieve a collection by its unique identifier. Use when you need to fetch detailed information about a specific collection including its name, description, settings, and permissions.
-
Get Comment
Tool to retrieve a comment by its ID from Outline. Use when you need to fetch detailed information about a specific comment including its content, author, timestamps, and resolution status.
-
Get Document Children Structure
Tool to retrieve a document's child structure. Returns the nested document tree (hierarchy) for the children of the specified document. Use when you need to explore document organization or navigate the document…
-
Get Document Info
Tool to retrieve a document from Outline by its UUID, urlId, or shareId. Returns complete document information including title, content, metadata, timestamps, and access policies. Use when you need to fetch document…
-
Get File Operation Info
Tool to retrieve the details and current status of a file operation by its unique identifier. Use when you need to check the progress of import or export operations.
-
Get Group Info
Tool to retrieve a group by its unique identifier. Returns group details including name and member count. Use when you need to fetch information about a specific group.
-
Get OAuth Client Info
Tool to retrieve an OAuth client from Outline by its id or clientId. Returns complete OAuth client configuration including name, scopes, and redirect URIs. Use when you need to fetch OAuth client details.
-
Get Revision Info
Tool to retrieve a revision by its ID from Outline. A revision is a snapshot of a document at a specific point in time. Use when you need to fetch historical document content or view editing history.
-
Get Share Info
Tool to retrieve a share object by its unique identifier or by the associated document ID. Returns complete share information including URL, visibility settings, access permissions, and view statistics. Use when you…
-
Get Template Info
Tool to retrieve a template by its unique identifier. Use when you need to fetch detailed information about a specific template including its title, content, and metadata.
-
Get User Info
Tool to retrieve a user by their unique identifier. Returns user details including name, email, avatar, role, and status. Use when you need to fetch information about a specific user.
-
Invite Users
Tool to invite users to the Outline workspace. Use when you need to send email invitations to one or more users to join the workspace.
-
List Archived Documents
List all archived documents in the Outline workspace. Returns paginated archived documents that the current user has access to, with metadata and authorization policies. Use limit and offset for pagination through…
-
List Collection Group Memberships
Tool to list all group memberships for a specific collection in Outline. Use when you need to see which groups have access to a collection and their permission levels. Returns both group details and membership…
-
List Collection Memberships
Tool to list all individual user memberships for a collection. Use when you need to see who has access to a specific collection and their permission levels. Note: This only returns individual user memberships, not…
-
List Collections
Tool to list all collections that the authenticated user has access to. Use when you need to retrieve all collections, optionally filtered by name or status, with pagination and sorting support.
-
List Comments
Tool to retrieve all comments with optional filtering by document or collection. Use when you need to list comments, view comment threads, or monitor discussions. Supports pagination and sorting for large result sets…
-
List Data Attributes
Tool to list all data attributes in Outline. Use when you need to retrieve custom data attributes that can be attached to documents for structured metadata.
-
List Deleted Documents
Tool to list all deleted documents in the workspace that the current user has access to. Use when you need to retrieve, review, or restore documents that have been deleted. Supports pagination and sorting to…
-
List Document Group Memberships
Tool to list a document's group memberships. Use when you need to see which groups have access to a specific document and their permission levels.
-
List Document Memberships
Tool to list users with direct membership to a document. Use when you need to see who has direct access to a specific document and their permission levels. Note: This returns only users with direct memberships. To list…
-
List Document Users
Tool to list all users with access to a document. Returns all users who have any level of access to the specified document. Use when you need to see who can view or edit a document.
-
List Documents
Tool to list all documents in your Outline workspace. Returns published documents and draft documents belonging to the current user. Use filters to narrow results by collection, creator, status, or document…
-
List Draft Documents
Tool to list all draft documents belonging to the current user. Use when you need to retrieve unpublished documents. Supports filtering by collection, date recency, pagination, and sorting.
-
List Events
Tool to list all events from the audit trail. Use when you need to track actions taken in the knowledge base, such as document creation, permission changes, or user activity. Events provide a comprehensive audit trail…
-
List File Operations
Tool to list all file operations for the workspace. Returns background jobs for importing or exporting files, filtered by type. Use to monitor export/import progress and retrieve download URLs for completed operations.
-
List Group Memberships
Tool to list all members of a specific group in Outline. Use when you need to see which users belong to a group. Returns user details and membership relationships.
-
List Groups
Tool to list all groups in the workspace. Groups organize users and manage permissions for collections. Use when you need to retrieve all groups, optionally filtered by name, with pagination and sorting support.
-
List OAuth Authentications
Tool to list all OAuth authentications for the current user. Use when you need to see which third-party applications have been authorized to access the user's account.
-
List OAuth Clients
Tool to list all OAuth clients accessible to the authenticated user. Use when you need to retrieve OAuth clients for third-party integrations. Returns both clients created by the user and published clients available to…
-
List Recently Viewed Documents
Tool to list all recently viewed documents by the current user. Returns documents ordered by when they were last viewed. Supports pagination and sorting for large result sets.
-
List Revisions
Tool to list all revisions for a specific document. Revisions represent historical snapshots of document content and are useful for tracking changes over time. Use when you need to view a document's editing history or…
-
List Shares
Tool to list all share links in the workspace. Use when you need to retrieve all public document shares, optionally filtered by search query, with pagination and sorting support.
-
List Stars
Tool to list all starred documents and collections for the authenticated user. Use when you need to retrieve bookmarked items that users have marked for quick access in their sidebar.
-
List Templates
Tool to list all templates available to the current user. Use when you need to retrieve all templates, optionally filtered by collection or name, with pagination and sorting support. Templates not associated with a…
-
List Users
Tool to list all users in the workspace. Use when you need to retrieve all users, optionally filtered by name, email, or status, with pagination and sorting support.
-
List Views
Tool to list all users that have viewed a specific document and the overall view count. Use when you need to see who has accessed a document and how many times they've viewed it. Returns view records including…
-
Move Document
Tool to move a document to a new location or collection in Outline. Use when you need to reorganize documents by moving them to a different collection or nesting them under a different parent document.
-
Redirect File Operation
Tool to retrieve a file from Outline by file operation ID. Loads the resulting file from where it is stored based on the id. A temporary signed URL with embedded credentials is generated on demand. Use when you need to…
-
Remove Collection Group
Tool to remove a group from a collection, revoking access for all group members. Use when you need to remove group-level access to a collection. Note that members may retain access through other groups or individual…
-
Remove Collection User
Tool to remove a user from a collection. Use when you need to revoke a user's access to a specific collection in Outline.
-
Remove Document User
Tool to remove a user membership from a document. Use when you need to revoke a user's access to a specific document.
-
Remove Group From Document
Tool to remove a group from a document, revoking access for all group members. Use when you need to revoke document-level access for an entire group at once.
-
Remove Group User
Tool to remove a user from a group. Use when you need to revoke a user's group membership in Outline.
-
Restore Document
Tool to restore a document in Outline. If a document has been archived or deleted, it can be restored. Optionally a revision can be passed to restore the document to a previous point in time.
-
Restore Template
Tool to restore a previously deleted template in Outline. Use when you need to recover a template that was soft-deleted.
-
Retrieve Auth Info
Tool to retrieve authentication details for the current API key. Use when you need to verify that an API token is valid or obtain identifying information for the authenticated user and workspace.
-
Revoke Share
Tool to revoke a share in Outline, making the share link inactive so it can no longer be used to access the document. Use when you need to disable public access to a shared document.
-
Rotate OAuth Client Secret
Tool to rotate the secret for an OAuth client in Outline. Use when you need to generate a new client secret for an OAuth client. The old secret will be invalidated immediately.
-
Search Document Titles
Tool to search document titles in Outline workspace using keywords. Unlike full document search, this searches only titles and returns faster results. Use when you need to quickly find documents by their title…
-
Search Documents
Tool to search all documents in your Outline workspace using keywords. Results are restricted to documents accessible by the current access token. Use filters to narrow results by collection, user, status, or…
-
Suspend User
Tool to suspend a user in Outline. Suspending a user prevents them from signing in and they are not counted against billing totals. Use when you need to temporarily disable a user's access without deleting their account.
-
Unpublish Document
Tool to unpublish a document in Outline. Unpublishing moves the document back to draft status and removes it from the collection. Use when you need to make a published document private again.
-
Update Collection
Tool to update an existing collection's properties in Outline. Use when you need to modify collection settings such as name, description, icon, color, sharing settings, or permission level.
-
Update Comment
Tool to update a comment in Outline. Use when you need to modify the content of an existing comment. The comment body should be provided in ProseMirror document format with type and content fields.
-
Update Document
Tool to update a document in Outline. Use when you need to modify an existing document's title, content, or metadata. At least the document ID is required.
-
Update Group
Tool to update an existing group's name in Outline. Use when you need to rename a group.
-
Update OAuth Client
Tool to update an existing OAuth client in Outline. Use when you need to modify an OAuth client's properties such as name, description, redirect URIs, or published status.
-
Update Share
Tool to update a share in Outline. Use when you need to change a share's published status, which controls whether authentication is required to access the shared link.
-
Update Star
Tool to update a star's position in the Outline sidebar. Use when you need to reorder a user's starred documents or collections by changing the display index.
-
Update Template
Tool to update an existing template in Outline. Use when you need to modify a template's title, content, icon, color, or other properties. At least the template ID is required.
-
Update User
Tool to update a user's name, avatar, or language preference in Outline. If no ID is provided, updates the authenticated user. Use when you need to modify user profile information.
-
Update User Role
Tool to change a user's role in Outline workspace. Use when you need to promote a user to admin, demote an admin to member, or change a user to viewer role. Only available to admin users.
Setup
Connect Outline 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.
