Overview
The Postman integration connects Hatz to your Postman workspaces, enabling your AI assistant and workflows to browse, inspect, and reason about your Postman collections, APIs, requests, environments, and workspaces — all without leaving Hatz.
Whether you're debugging an integration, exploring APIs for automation, or building workflows that reference your existing Postman setups, this integration brings your Postman data directly into your AI-powered conversations and workflow automations.
How the Integration Works
Hatz connects to Postman's hosted MCP (Model Context Protocol) server at https://mcp.postman.com/mcp using your personal Postman API key for authentication. When the Postman tool is invoked in a chat or workflow, Hatz securely passes your API key as a Bearer token to the Postman MCP server, which then responds with your Postman data in real time.
This is a per-user integration. Each user in Hatz who wants access to Postman data needs to individually set up the integration using their own Postman API key.
Prerequisites
Before setting up the integration, make sure you have:
An active Postman account (free or paid)
Access to generate API keys in your Postman account settings
Integration Process
Step 1 — Generate a Postman API Key
Log in to your Postman account at postman.com
Click the Settings icon in the top right and then select Account settings
In your account settings, click API keys in the left navigation
If you don't already have a key, click Generate API Key
Enter a descriptive name for the key (e.g., Hatz Integration) and click Generate API Key
Copy and save the key in a safe place
Step 2 — Configure the Postman Integration in Hatz
Login to Hatz, select Workshop at the top and then select Connections on the left menu
Find Postman in the list of available integrations and click Add
Paste the API Key you copied in Step 1 into the token field
Click Connect and verify that Postman is connected
Tools Available After Integration
After successfully connecting Postman, the Postman tool becomes available in Hatz Chat and Workflows. Here's what you can do with it:
Tool | Description |
addWorkspaceToPrivateNetwork | Publishes a workspace to the team's Private API Network |
createCollection | Creates a new collection using the Postman Collection v2.1.0 schema format |
createCollectionComment | Creates a comment on a collection |
createCollectionFolder | Creates a folder in a collection |
createCollectionFork | Creates a fork from an existing collection into a workspace |
createCollectionRequest | Creates a request in a collection |
createCollectionResponse | Creates a request response in a collection |
createEnvironment | Creates a new environment |
createFolderComment | Creates a comment on a folder |
createMock | Creates a mock server in a collection |
createMonitor | Creates a monitor |
createRequestComment | Creates a comment on a request |
createResponseComment | Creates a comment on a response |
createSpec | Creates an API specification in Spec Hub |
createSpecFile | Creates an API specification file |
createWorkspace | Creates a new workspace |
deleteApiCollectionComment | Deletes a comment from an API's collection |
deleteCollection | Deletes a collection |
deleteCollectionComment | Deletes a comment from a collection |
deleteCollectionFolder | Deletes a folder in a collection |
deleteCollectionRequest | Deletes a request in a collection |
deleteCollectionResponse | Deletes a response in a collection |
deleteEnvironment | Deletes an environment |
deleteFolderComment | Deletes a comment from a folder |
deleteMock | Deletes a mock server |
deleteMonitor | Deletes a monitor |
deleteRequestComment | Deletes a comment from a request |
deleteResponseComment | Deletes a comment from a response |
deleteSpec | Deletes an API specification |
deleteSpecFile | Deletes a file in an API specification |
deleteWorkspace | Deletes an existing workspace |
duplicateCollection | Creates a duplicate of a given collection in another workspace |
generateCollection | Creates a collection from a given API specification |
generateSpecFromCollection | Generates an API specification (OpenAPI) for a given collection |
getAllSpecs | Gets all API specifications in a workspace |
getAnalyticsData | Gets analytics data based on specified resource, metrics, and filters |
getAnalyticsMetadata | Returns a catalog of analytics resources and their metrics |
getAsyncSpecTaskStatus | Gets the status of an asynchronous API specification creation task |
getAuthenticatedUser | Gets information about the authenticated user |
getCodeGenerationInstructions | Returns instructions for searching APIs and generating client code |
getCollection | Gets information about a collection |
getCollectionComments | Gets all comments in a collection |
getCollectionFolder | Gets information about a folder in a collection |
getCollectionForks | Gets a collection's forked collections |
getCollectionRequest | Gets information about a request in a collection |
getCollectionResponse | Gets information about a response in a collection |
getCollectionTags | Gets all tags associated with a collection |
getCollectionUpdatesTasks | Gets the status of an asynchronous collection update task |
getCollections | Gets all collections in a workspace |
getCollectionsForkedByUser | Gets a list of all forked collections by the authenticated user |
getDuplicateCollectionTaskStatus | Gets the status of a collection duplication task |
getEnabledTools | Returns information about which tools are enabled |
getEnvironment | Gets information about an environment |
getEnvironments | Gets all environments in a workspace |
getFolderComments | Gets all comments in a folder |
getGeneratedCollectionSpecs | Gets the API specification generated for a collection |
getMock | Gets information about a mock server |
getMocks | Gets all active mock servers |
getMonitor | Gets information about a monitor |
getMonitors | Gets all monitors |
getRequestComments | Gets all comments on a request |
getResponseComments | Gets all comments on a response |
getSourceCollectionStatus | Checks whether there are changes between a forked and parent collection |
getSpec | Gets information about an API specification |
getSpecCollections | Gets all generated collections from a specification |
getSpecDefinition | Gets the complete contents of an API specification's definition |
getSpecFile | Gets the contents of an API specification's file |
getSpecFiles | Gets all files in an API specification |
getStatusOfAnAsyncApiTask | Gets the status of an asynchronous task |
getTaggedEntities | Gets Postman elements by a given tag (Enterprise plan only) |
getWorkspace | Gets information about a workspace |
getWorkspaceGlobalVariables | Gets a workspace's global variables |
getWorkspaceTags | Gets all tags associated with a workspace |
getWorkspaces | Gets all workspaces the user has access to |
listPrivateNetworkAddRequests | Gets requests to add workspaces to the Private API Network |
listPrivateNetworkWorkspaces | Gets workspaces added to the Private API Network |
mergeCollectionFork | Merges a forked collection back into its parent collection |
patchCollection | Updates specific collection information (name, events, variables) |
patchEnvironment | Updates specific environment properties (name, variables) |
publishDocumentation | Publishes a collection's documentation (makes it publicly available) |
publishMock | Publishes a mock server (sets to public access) |
pullCollectionChanges | Pulls changes from a parent collection into a forked collection |
putCollection | Replaces the entire contents of a collection |
putEnvironment | Replaces all contents of an environment |
removeWorkspaceFromPrivateNetwork | Removes a workspace from the Private API Network |
resolveCommentThread | Resolves a comment thread and any associated replies |
respondPrivateNetworkAddRequest | Approves or denies a request to add a workspace to the Private API Network |
runMonitor | Runs a monitor and returns its run results |
searchPostmanElementsInPrivateNetwork | Searches for API requests and collections in the Private API Network |
searchPostmanElementsInPublicNetwork | Searches for Postman elements in the public network |
syncCollectionWithSpec | Syncs a collection generated from an API specification |
syncSpecWithCollection | Syncs an API specification linked to a collection |
transferCollectionFolders | Copies or moves folders into a collection or folder |
transferCollectionRequests | Copies or moves requests into a collection or folder |
transferCollectionResponses | Copies or moves responses into a request |
unpublishDocumentation | Unpublishes a collection's documentation |
unpublishMock | Unpublishes a mock server (sets to private) |
updateApiCollectionComment | Updates a comment on an API's collection |
updateCollectionComment | Updates a comment on a collection |
updateCollectionFolder | Updates a folder in a collection |
updateCollectionRequest | Updates a request in a collection |
updateCollectionResponse | Updates a response in a collection |
updateCollectionTags | Updates a collection's associated tags |
updateFolderComment | Updates a comment on a folder |
updateMock | Updates a mock server |
updateMonitor | Updates a monitor's configurations |
updateRequestComment | Updates a comment on a request |
updateResponseComment | Updates a comment on a response |
updateSpecFile | Updates an API specification's file |
updateSpecProperties | Updates an API specification's properties |
updateWorkspace | Updates a workspace's properties (name, visibility) |
updateWorkspaceGlobalVariables | Updates a workspace's global variables |
updateWorkspaceTags | Updates a workspace's associated tags |