You are here:
Postman Connector (Beta)
Connect to an external Postman account. Perform tasks like managing collections or creating API documentation. Use Postman as a data target (action).
Required Editions
| View supported editions. |
| This feature requires the MuleSoft for Flow: Integration add-on. Professional Edition requires the API access add-on. To purchase, contact your Salesforce account executive. |
| MuleSoft for Flow: Integration features used with Agentforce require the Foundations or Agentforce 1 edition. To purchase these editions, contact your Salesforce account executive. |
Connections
To connect to a system, whether it's a data source or a data target, create a connection with that system's standard connection or with an existing external named credential. You can connect to multiple systems within a flow and reuse each connection. You can create connections in the Integrations tab or in Flow Builder.
Standard Connection
This system uses ApiKey authentication.
ApiKey authentication connects to applications without explicitly defining a user. Add this key to all requests, and the cloud application identifies the origin of the request and completes the authorization.
This system requires this credential information for its connections.
| FIELD | DESCRIPTION |
|---|---|
| Connection Name | Enter a unique connection name that helps you remember the details of this connection. Salesforce hides the credentials after you create the connection. Reuse connections as needed. Anyone with the Manage Integration Connections permission can see and use all connections in the org. |
| ApiKey | Enter the API key to use to authenticate the requests. |
| URL | Enter the URL of your instance. |
Named Credential Connection
Select a pre-existing named credential from Setup to use for your external system connections.
Before connecting to your external system with a named credential, first create or use an existing authenticated named credential and external credential that is enabled for your users.
To ensure a successful connection for use in a flow, use only one principal for each named credential.
- Use the same name for the named credential and its related objects, such as the external credential and external authentication identity providers. Labels for these objects can differ.
- Assign the user creating the connection the required user permission for the principal. Without this permission, the connection test fails and the connection remains inactive.
When you create a connection with an existing named credential, note these behaviors:
- Manage the named credential’s read-only details in Setup, not the Integrations tab. On the Integrations tab, you can only edit the connection's Connection Name and Description.
- Perform reconnections for the named credential in Setup. The Reconnect button isn’t visible on the Details page.
- Delete associated named credentials in Setup. Deleting a connection doesn't remove the credential.
Actions
An action performs a specific task or operation within a target system. Use actions to automate tasks across different systems without manual intervention, based on conditions set in the flow. For more information about actions, refer to Create a Flow with a Connector as an Action.
These Postman actions are available in Flow Builder.
- Async Merge Pull Collection Fork
- Async Merge Pull Collection Task Status
- Create Api
- Create Api Collection Comment
- Create Api Comment
- Create Api Schema
- Create Collection Comment
- Create Collection Folder
- Create Collection Fork
- Create Collection Pull Request
- Create Collection Request
- Create Collection Response
- Create Environment
- Create Folder Comment
- Create Mock
- Create Mock Server Response
- Create Monitor
- Create Request Comment
- Create Response Comment
- Create Scim Group
- Create Scim User
- Create Spec File
- Create Update Api Schema File
- Create Webhook
- Create Workspace
- Delete Api
- Delete Api Collection Comment
- Delete Api Comment
- Delete Api Schema File
- Delete Api Version
- Delete Collection
- Delete Collection Access Key
- Delete Collection Comment
- Delete Collection Folder
- Delete Collection Request
- Delete Collection Response
- Delete Environment
- Delete Folder Comment
- Delete Mock
- Delete Mock Server Response
- Delete Monitor
- Delete Pan Element Or Folder
- Delete Request Comment
- Delete Response Comment
- Delete Scim Group
- Delete Spec
- Delete Spec File
- Delete Workspace
- Detected Secrets Queries
- Duplicate Collection
- Fork Environment
- Generate Collection
- Generate Spec From Collection
- Generate Tool
- Get Account Invoices
- Get Accounts
- Get All Elements And Folders
- Get All Pan Add Element Requests
- Get All Specs
- Get All Workspace Roles
- Get Api Collection
- Get Api Collection Comments
- Get Api Comments
- Get Api Schema File Contents
- Get Api Schema Files
- Get Api Tags
- Get Api Version
- Get Api Versions
- Get Apis
- Get Audit Logs
- Get Authenticated User
- Get Collection Access Keys
- Get Collection Comments
- Get Collection Folder
- Get Collection Forks
- Get Collection Pull Requests
- Get Collection Request
- Get Collection Response
- Get Collection Roles
- Get Collection Tags
- Get Collection Updates Tasks
- Get Collections
- Get Collections Forked By User
- Get Detected Secrets Locations
- Get Duplicate Collection Task Status
- Get Environment
- Get Environment Forks
- Get Environments
- Get Folder Comments
- Get Generated Collection Specs
- Get Group
- Get Groups
- Get Mock
- Get Mock Call Logs
- Get Mock Server Response
- Get Mock Server Responses
- Get Mocks
- Get Monitor
- Get Monitors
- Get Pull Request
- Get Request Comments
- Get Response Comments
- Get Runner Instances
- Get Runner Metrics
- Get Scim Group Resource
- Get Scim Group Resources
- Get Scim Resource Types
- Get Scim Service Provider Config
- Get Scim User Resource
- Get Scim User Resources
- Get Secret Types
- Get Source Collection Status
- Get Spec
- Get Spec Collections
- Get Spec File
- Get Spec Files
- Get Status Of An Async Api Task
- Get Tagged Entities
- Get Team User
- Get Team Users
- Get Workspace
- Get Workspace Activity Feed
- Get Workspace Global Variables
- Get Workspace Roles
- Get Workspace Tags
- Get Workspaces
- Merge Collection Fork
- Merge Environment Fork
- Patch Collection
- Publish Documentation
- Publish Mock
- Pull Collection Changes
- Pull Environment
- Put Environment
- Resolve Comment Thread
- Respond Pan Element Add Request
- Review Pull Request
- Run Monitor
- Schema Security Validation
- Scim Update Group
- Sync Collection With Schema
- Sync Collection With Spec
- Sync Spec With Collection
- Transfer Collection Folders
- Transfer Collection Requests
- Transfer Collection Responses
- Transfer Workspace Element
- Transform Collection To Open Api
- Unpublish Documentation
- Unpublish Mock
- Update Api
- Update Api Collection Comment
- Update Api Comment
- Update Api Tags
- Update Api Version
- Update Collection Comment
- Update Collection Folder
- Update Collection Request
- Update Collection Response
- Update Collection Roles
- Update Collection Tags
- Update Detected Secret Resolutions
- Update Folder Comment
- Update Mock
- Update Mock Server Response
- Update Monitor
- Update Pull Request
- Update Request Comment
- Update Response Comment
- Update Scim User
- Update Spec File
- Update Spec Properties
- Update Spec Sync Options
- Update Workspace
- Update Workspace Global Variables
- Update Workspace Roles
- Update Workspace Tags
For information about specific limitations for connections and third-party connectors, see MuleSoft for Flow: Integration Limits & Considerations.
