Skip to docs navigation

Postman integration guide

Verified

How to connect Postman to WEXTL and use its 3 triggers and 147 actions in your workflows. About Postman: Manage Postman collections, environments, mock servers, monitors, specs and workspaces.

  • 3 triggers
  • 59 searches
  • 88 actions
  • Polling
  • Auth: API key

AI-assisted documentation34 min read

This documentation is compiled from our integration source code, internal specs for Postman, its official API documentation and anonymized requests logs we collect from our support team[2].

Open Postman on WEXTL →
  • Postman
  • WEXTL
  • API Verve
  • Buildkite
  • 0CodeKit
  • Cockpit
  • AWS Cognito
  • AWS Lambda
  • Azure Storage
  • Cloudflare
  • Bunny.net
  • Clerk
  • Browserless
  • AssemblyAI
  • Cortex
  • Adafruit
  • Apify
  • CircleCI
  • AWS S3
  • CloudConvert
  • Better Stack
  • Currents
  • Alchemy
  • BugBug
  • Contentful
  • Agenty
  • Bright Data
  • Browse AI
  • Crowdin
  • Bitbucket
  • Box
  • Bitwarden
  • RegionselectRequired

    Pick EU only if your team uses the EU data region. A key from the other region is rejected.[1]

  • API KeypasswordRequired

    In Postman open Settings, then Account settings, then API keys, and generate a key.[1]

  1. Log in to your WEXTL account, add the Postman node module to your workflow, and click Create new credential.
  2. Optional: In the Credential name field, enter a name for the credential.
  3. Enter the authentication credentials you copied from your Postman account, or follow the on-screen instructions to create the credential.
  4. If prompted, authenticate your account and confirm access.
  5. If you want to make changes to your credential in the future, follow the steps in Manage credentials →

Watch Mock Calls

TriggerScheduled mock traffic check.
Input fields[3]
FieldType
Mock ServerRequired
choice
Limitnumber
Output fields[3]
FieldType
Idtext
Response Nametext
Served Atdate
Requestobject
Methodtext
Pathtext
Responseobject
Typetext
Status Codenumber

Watch Monitor Runs

TriggerScheduled run history check.
Input fields[3]
FieldType
MonitorRequired
choice
Limitnumber
Output fields[3]
FieldType
Monitor Idtext
Monitor Uidtext
Nametext
Statustext
Started Atdate
Finished Atdate
Statsobject
Assertionsobject

Watch Workspace Activity

TriggerChecks the activity feed at set intervals.
Input fields[3]
FieldType
WorkspaceRequired
choice
Element Typechoice
Limitnumber
Output fields[3]
FieldType
Workspace Idtext
Created Atdate
Updated Atdate
Idnumber
Userobject
Idnumber
Usernametext
Is Partnerboolean
Nametext
Actiontext
Element Typetext
Triggertext

2other output fields

Get a Collection

ActionComplete collection definition as JSON.
Input fields[3]
FieldType
CollectionRequired
choice
Modelchoice
Access Keytext
Output fields[3]
FieldType
Infoobject
postman idtext
Nametext
Descriptiontext
Schematext
Updated Atdate
Uidtext
Created Atdate
Last Updated Bytext
Itemarray
Authobject
Typetext
Apikeyarray
Eventobject
0object
1object
Variableobject
0object

Get a Collection Folder

ActionFolder ownership and contents.
Input fields[3]
FieldType
CollectionRequired
choice
Folder IDRequired
text
Populateboolean
Output fields[3]
FieldType
Idtext
Nametext
Descriptiontext
Created Atdate
Updated Atdate
Ownertext
Collectiontext
Authobject
Apikeyarray
Typetext

5other output fields

Get a Collection Merge Status

ActionHow far a merge has progressed.
Input fields[3]
FieldType
Task IDRequired
text
Output fields[3]
FieldType
Idtext
Statustext

Get a Collection Request

ActionSaved call with ownership and revision.
Input fields[3]
FieldType
CollectionRequired
choice
Request IDRequired
text
Populateboolean
Output fields[3]
FieldType
Idtext
Nametext
Ownertext
Last Revisionnumber
Last Updated Bytext
Created Atdate
Updated Atdate
Authtext

23other output fields

Get a Collection Response

ActionSample reply with its parent request.
Input fields[3]
FieldType
CollectionRequired
choice
Response IDRequired
text
Output fields[3]
FieldType
Idtext
Requesttext
Nametext
Ownertext
Created Atdate
Updated Atdate
Last Revisionnumber
Last Updated Bytext

10other output fields

Get a Collection Update Status

ActionProgress of a running update job.
Input fields[3]
FieldType
Task IDRequired
text
Output fields[3]
FieldType
Idtext
Statustext

Get a Duplicate Collection Status

ActionProgress of a running copy job.
Input fields[3]
FieldType
Task IDRequired
text
Output fields[3]
FieldType
Taskobject
Idtext
Statustext
Reasontext

Get a Mock Response

ActionDetails of a canned reply.
Input fields[3]
FieldType
Mock ServerRequired
choice
Server Response IDRequired
text
Output fields[3]
FieldType
Created Atdate
Updated Atdate
Idtext
Nametext
Status Codenumber
Headersarray
Bodytext
Created Bytext

2other output fields

Get a Mock Server

ActionMock server details and URL.
Input fields[3]
FieldType
Mock ServerRequired
choice
Output fields[3]
FieldType
Idtext
Ownertext
Uidtext
Collectiontext
Mock Urltext
Nametext
Configobject
Delayobject
Headersarray
Match Bodyboolean
Match Headerboolean
Match Query Paramsboolean
Match Wildcardsboolean
Server Response Idtext
Created Atdate

4other output fields

Get a Monitor

ActionSettings of a scheduled run.
Input fields[3]
FieldType
MonitorRequired
choice
Output fields[3]
FieldType
Idtext
Nametext
Uidtext
Ownernumber
Activeboolean
Notification Limitnumber
Collection Uidtext
Environment Uidtext

6other output fields

Get a Pull Request

ActionMerge proposal with author and text.
Input fields[3]
FieldType
Pull Request IDRequired
text
Output fields[3]
FieldType
Created Atdate
Updated Atdate
Idtext
Titletext
Descriptiontext
Created Bytext
Updated Bytext
Commenttext

6other output fields

Get a Source Collection Status

ActionFork drift against the source.
Input fields[3]
FieldType
CollectionRequired
choice
Output fields[3]
FieldType
Collectionobject
12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2object

Get a Spec

ActionFormat and author of an API spec.
Input fields[3]
FieldType
SpecRequired
choice
Output fields[3]
FieldType
Idtext
File Formattext
Nametext
Typetext
Created Bynumber
Updated Bynumber
Created Atdate
Updated Atdate

Get a Spec Definition

ActionParsed body of an API spec.
Input fields[3]
FieldType
SpecRequired
choice
Output fields[3]
FieldType
Componentsobject
Security Schemesobject
Infoobject
Contactobject
Descriptiontext
Titletext
Versiontext
Openapitext
Pathsobject
/spacecrafts/{spacecraft Id}object
Securityarray
Serversarray

Get a Spec File

ActionDocument inside a spec, with authorship.
Input fields[3]
FieldType
SpecRequired
choice
File PathRequired
text
Output fields[3]
FieldType
Idtext
Nametext
Pathtext
Created Bynumber
Updated Bynumber
Created Atdate
Updated Atdate
Typetext

1other output field

Get a Spec Task Status

ActionProgress report on a spec job.
Input fields[3]
FieldType
Element TypeRequired
choice
Element IDRequired
text
Task IDRequired
text
Output fields[3]
FieldType
Metaobject
Actiontext
Modeltext
Statustext

Get a Team

ActionHandle and profile of your team.
Input fields[3]
FieldType
TeamRequired
choice
Includechoice
Output fields[3]
FieldType
Created Atdate
Updated Atdate
Idnumber
Nametext
Handletext
Descriptiontext
Organization Idnumber
Created Bynumber

1other output field

Get a Team User

ActionProfile of one member.
Input fields[3]
FieldType
User IDRequired
text
Output fields[3]
FieldType
Idnumber
Nametext
Usernametext
Emailtext
Rolesarray
Joined Atdate

Get a Workspace

ActionType, visibility and creator of a workspace.
Input fields[3]
FieldType
WorkspaceRequired
choice
Output fields[3]
FieldType
Idtext
Nametext
Typetext
Descriptiontext
Visibilitytext
Created Bytext
Updated Bytext
Created Atdate

8other output fields

Get a Workspace Update

ActionSingle post from the feed.
Input fields[3]
FieldType
WorkspaceRequired
choice
Update IDRequired
text
Output fields[3]
FieldType
Idnumber
Topictext
Descriptiontext
Workspace Idtext
Created Byobject
Idnumber
Nametext
Usernametext
Updated Bynumber
Created Atdate
Updated Atdate

3other output fields

Get an API

ActionFull profile of one API.
Input fields[3]
FieldType
APIRequired
choice
Includechoice
Output fields[3]
FieldType
Collectionsarray
Created Atdate
Created Bynumber
Descriptiontext
Git Infotext
Idtext
Nametext
Schemasarray

4other output fields

Get an API Schema

ActionContents of one API schema, merged on request.
Input fields[3]
FieldType
APIRequired
choice
Schema IDRequired
text
Version IDtext
Bundledboolean
Output fields[3]
FieldType
Created Atdate
Filesobject
Dataarray
Metaobject
Updated Atdate

Get an API Schema File

ActionRaw content of a schema file.
Input fields[3]
FieldType
APIRequired
choice
Schema IDRequired
text
File PathRequired
text
Version IDtext
Output fields[3]
FieldType
Idtext
Nametext
Pathtext
Contenttext
Created Atdate
Created Bytext
Updated Atdate
Updated Bytext

Get an API Version

ActionOne named API release.
Input fields[3]
FieldType
APIRequired
choice
Version IDRequired
text
Output fields[3]
FieldType
Versionobject
Idtext
Nametext
Created Atdate
Updated Atdate
Release Notestext
Schemasarray
Collectionsarray

Get an Environment

ActionVariables and owner of an environment.
Input fields[3]
FieldType
EnvironmentRequired
choice
Output fields[3]
FieldType
Idtext
Nametext
Ownertext
Created Atdate
Updated Atdate
Valuesarray
Is Publicboolean

Get Collection Tags

ActionLabels currently on a collection.
Input fields[3]
FieldType
CollectionRequired
choice
Output fields[3]
FieldType
Tagsarray

Get Spec Version Files

ActionFrozen file set of a tagged spec.
Input fields[3]
FieldType
SpecRequired
choice
Tag IDRequired
text
Output fields[3]
FieldType
Dataarray

Get the Current User

ActionAccount behind your API key.
Output fields[3]
FieldType
Userobject
Idnumber
Subtext
Usernametext
Emailtext
Full Nametext
Avatartext
Is Publicboolean
Email Verifiedboolean
Team Idnumber
Team Nametext
Operationsarray

Get Workspace Tags

ActionLabels assigned to a workspace.
Input fields[3]
FieldType
WorkspaceRequired
choice
Output fields[3]
FieldType
Tagsarray

Get Workspace Variables

ActionShared values defined for a workspace.
Input fields[3]
FieldType
WorkspaceRequired
choice
Output fields[3]
FieldType
Valuesarray

List API Schema Files

SearchDocuments bundled in a schema.
Input fields[3]
FieldType
APIRequired
choice
Schema IDRequired
text
Version IDtext
Limitnumber
Output fields[3]
FieldType
Idtext
Nametext
Pathtext
Created Atdate
Created Bynumber
Updated Atdate
Updated Bynumber

List API Versions

SearchRelease history of an API.
Input fields[3]
FieldType
APIRequired
choice
Limitnumber
Output fields[3]
FieldType
Idtext
Nametext
Created Atdate
Updated Atdate
Release Notestext

List APIs

SearchAPI catalog of a workspace.
Input fields[3]
FieldType
WorkspaceRequired
choice
Created Bynumber
Descriptiontext
Limitnumber
Output fields[3]
FieldType
Idtext
Nametext
Summarytext
Created Atdate
Created Bynumber
Updated Atdate
Updated Bynumber
Descriptiontext

List Collection Comments

SearchDiscussion posted on a collection.
Input fields[3]
FieldType
CollectionRequired
choice
Limitnumber
Output fields[3]
FieldType
Idnumber
Thread Idnumber
Statustext
Created Bynumber
Created Atdate
Updated Atdate
Bodytext

List Collection Forks

SearchCopies branched from a collection.
Input fields[3]
FieldType
CollectionRequired
choice
Directionchoice
Limitnumber
Output fields[3]
FieldType
Created Atdate
Created Bytext
Fork Idtext
Fork Nametext

List Collection Pull Requests

SearchMerge proposals for a collection.
Input fields[3]
FieldType
CollectionRequired
choice
Limitnumber
Output fields[3]
FieldType
Created Atdate
Created Bytext
Descriptiontext
Destination Idtext
Hreftext
Idtext
Source Idtext
Statustext

3other output fields

List Collection Specs

SearchAPI definitions created from one collection.
Input fields[3]
FieldType
CollectionRequired
choice
Limitnumber
Output fields[3]
FieldType
Idtext
Nametext
Statetext
Created Atdate
Updated Atdate
Created Bynumber
Updated Bynumber

List Collections

SearchEvery collection your account can open.
Input fields[3]
FieldType
Workspacechoice
Nametext
Limitnumber
Output fields[3]
FieldType
Idtext
Nametext
Ownertext
Created Atdate
Updated Atdate
Uidtext
Is Publicboolean

List Environment Forks

SearchCopies branched from an environment.
Input fields[3]
FieldType
EnvironmentRequired
choice
Directionchoice
Limitnumber
Output fields[3]
FieldType
Fork Idtext
Fork Nametext
Created Atdate
Created Bytext
Updated Atdate

List Environments

SearchEnvironments across your account.
Input fields[3]
FieldType
Workspacechoice
Limitnumber
Output fields[3]
FieldType
Idtext
Nametext
Created Atdate
Updated Atdate
Ownertext
Uidtext
Is Publicboolean

List Folder Comments

SearchConversation under a folder.
Input fields[3]
FieldType
CollectionRequired
choice
Folder IDRequired
text
Limitnumber
Output fields[3]
FieldType
Idnumber
Thread Idnumber
Statustext
Created Bynumber
Created Atdate
Updated Atdate
Bodytext

List Forked Collections

SearchYour own forks of other collections.
Input fields[3]
FieldType
Directionchoice
Limitnumber
Output fields[3]
FieldType
Fork Nametext
Fork Idtext
Source Idtext
Created Atdate

List Mock Calls

SearchTraffic log of a mock server.
Input fields[3]
FieldType
Mock ServerRequired
choice
Sincedate
Untildate
Status Codenumber
Response Typetext
Methodchoice
Pathtext
Directionchoice

1other input field

Output fields[3]
FieldType
Idtext
Response Nametext
Served Atdate
Requestobject
Methodtext
Pathtext
Responseobject
Typetext
Status Codenumber

List Mock Responses

SearchCanned replies on a mock.
Input fields[3]
FieldType
Mock ServerRequired
choice
Limitnumber
Output fields[3]
FieldType
Idtext
Nametext
Status Codenumber
Created Atdate
Updated Atdate
Created Bytext
Updated Bytext

List Mock Servers

SearchFake APIs configured on your account.
Input fields[3]
FieldType
Teamchoice
Workspacechoice
Limitnumber
Output fields[3]
FieldType
Idtext
Ownertext
Uidtext
Collectiontext
Mock Urltext
Nametext
Configobject
Delayobject
Headersarray
Match Bodyboolean
Match Headerboolean
Match Query Paramsboolean
Match Wildcardsboolean
Server Response Idtext
Created Atdate

4other output fields

List Monitors

SearchScheduled runs in your account.
Input fields[3]
FieldType
Workspacechoice
Activechoice
Owner IDnumber
Collectionchoice
Environmentchoice
Limitnumber
Output fields[3]
FieldType
Idtext
Nametext
Activeboolean
Uidtext
Ownernumber
Collection Uidtext
Environment Uidtext

List Request Comments

SearchFeedback left on a saved request.
Input fields[3]
FieldType
CollectionRequired
choice
Request IDRequired
text
Limitnumber
Output fields[3]
FieldType
Idnumber
Thread Idnumber
Statustext
Created Bynumber
Created Atdate
Updated Atdate
Bodytext

List Response Comments

SearchRemarks on a sample reply.
Input fields[3]
FieldType
CollectionRequired
choice
Response IDRequired
text
Limitnumber
Output fields[3]
FieldType
Idnumber
Thread Idnumber
Statustext
Created Bynumber
Created Atdate
Updated Atdate
Bodytext

List Spec Collections

SearchRequest sets generated from one spec.
Input fields[3]
FieldType
SpecRequired
choice
Limitnumber
Output fields[3]
FieldType
Idtext
Nametext
Statetext
Created Atdate
Updated Atdate
Created Bynumber

List Spec Files

SearchDefinition files inside an API spec.
Input fields[3]
FieldType
SpecRequired
choice
Limitnumber
Output fields[3]
FieldType
Idtext
Pathtext
Nametext
Created Bynumber
Updated Bynumber
Created Atdate
Updated Atdate
Typetext

List Spec Version Tags

SearchNamed checkpoints saved for a spec.
Input fields[3]
FieldType
SpecRequired
choice
Limitnumber
Output fields[3]
FieldType
Idtext
Nametext

List Specs

SearchAPI specs in a workspace.
Input fields[3]
FieldType
WorkspaceRequired
choice
Limitnumber
Output fields[3]
FieldType
Idtext
Nametext
Typetext
Created Bynumber
Updated Bynumber
Created Atdate
Updated Atdate

List Tagged Items

SearchEverything labeled with a tag.
Input fields[3]
FieldType
TagRequired
text
Item Typechoice
Directionchoice
Limitnumber
Output fields[3]
FieldType
Dataobject
Entitiesarray
Metaobject
Countnumber

List Team Users

SearchRoster with emails and roles.
Input fields[3]
FieldType
Group IDnumber
Limitnumber
Output fields[3]
FieldType
Idnumber
Nametext
Usernametext
Emailtext
Rolesarray
Joined Atdate

List Teams

SearchHandles and descriptions of your teams.
Input fields[3]
FieldType
Include Settingsboolean
Include User Rolesboolean
Limitnumber
Output fields[3]
FieldType
Created Atdate
Updated Atdate
Idnumber
Nametext
Handletext
Descriptiontext
Organization Idnumber
Created Bynumber

2other output fields

List Workspace Activity

SearchWho did what and when in a space.
Input fields[3]
FieldType
WorkspaceRequired
choice
User IDnumber
Element Typechoice
Limitnumber
Output fields[3]
FieldType
Workspace Idtext
Created Atdate
Updated Atdate
Idnumber
Userobject
Idnumber
Usernametext
Is Partnerboolean
Nametext
Actiontext
Element Typetext
Triggertext

2other output fields

List Workspace Updates

SearchAnnouncements shared with workspace members.
Input fields[3]
FieldType
WorkspaceRequired
choice
Categorychoice
Limitnumber
Output fields[3]
FieldType
Idnumber
Topictext
Descriptiontext
Workspace Idtext
Created Byobject
Idnumber
Nametext
Usernametext
Updated Bynumber
Created Atdate
Updated Atdate

3other output fields

List Workspaces

SearchSpaces your team organizes work in.
Input fields[3]
FieldType
Typechoice
Created Bynumber
Element Typechoice
Element IDtext
Include Deactivated Mocksboolean
Limitnumber
Output fields[3]
FieldType
Idtext
Nametext
Typetext
Visibilitytext
Created Bytext
Abouttext
Created Atdate
Updated Atdate

Search Postman

SearchCross-workspace content search.
Input fields[3]
FieldType
Element TypeRequired
choice
Searchtext
Ownershipchoice
Filters (JSON)text
Limitnumber
Output fields[3]
FieldType
Idtext
Nametext
Methodtext
Descriptiontext
Urltext
Created Bytext
Teamobject
Idtext
Nametext
Is Git Connectedboolean

4other output fields

Add a Collection to an API

ActionLinks collection data to an API definition.
Input fields[3]
FieldType
APIRequired
choice
Operation TypeRequired
choice
Data (JSON)Required
text
Output fields[3]
FieldType
Dataobject
Collection Idtext
Operation Typetext

Create a Collection

ActionCollection ready for requests.
Input fields[3]
FieldType
WorkspaceRequired
choice
NameRequired
text
Descriptiontext
Items (JSON)text
Variablesarray
Variableobject
Auth (JSON)text
Events (JSON)text
Output fields[3]
FieldType
Idtext
Nametext
Uidtext

Create a Collection Comment

ActionDiscussion note on a collection.
Input fields[3]
FieldType
CollectionRequired
choice
CommentRequired
text
Thread IDnumber
Tagged Usersarray
Userobject
Output fields[3]
FieldType
Bodytext
Tagsobject
@alex-cruzobject

Create a Collection Folder

ActionOrganizes requests into a new group.
Input fields[3]
FieldType
CollectionRequired
choice
NameRequired
text
Parent Folder IDtext
Output fields[3]
FieldType
Dataobject
Idtext
Nametext
Orderarray
Ownertext
Foldertext
Foldersarray
Requestsarray
Created Atdate
Updated Atdate
Collectiontext
Metaobject
Actiontext
Modeltext
Model idtext
Revisionnumber

Create a Collection Pull Request

ActionReview request for a forked collection.
Input fields[3]
FieldType
CollectionRequired
choice
TitleRequired
text
DestinationRequired
choice
ReviewersRequired
choice
Descriptiontext
Output fields[3]
FieldType
Created Atdate
Created Bytext
Descriptiontext
Destination Idtext
Idtext
Source Idtext
Statustext
Titletext

1other output field

Create a Collection Request

ActionStored HTTP call inside a collection.
Input fields[3]
FieldType
CollectionRequired
choice
Folder IDtext
Nametext
Methodchoice
URLtext
Descriptiontext
Headersarray
Rowobject
Query Parametersarray
Rowobject

7other input fields

Output fields[3]
FieldType
Dataobject
Idtext
Nametext
Ownertext
Foldertext
Responsesarray
Collectiontext
Responses orderarray
Created Atdate
Updated Atdate
Last Updated Bytext
Metaobject
Actiontext
Modeltext
Model idtext
Revisionnumber

Create a Collection Response

ActionSample reply saved on a request.
Input fields[3]
FieldType
CollectionRequired
choice
Request IDRequired
text
Nametext
URLtext
Methodchoice
Status Codenumber
Status Texttext
Headersarray
Rowobject

3other input fields

Output fields[3]
FieldType
Dataobject
Idtext
Ownertext
Requesttext
Created Atdate
Updated Atdate
Last Updated Bytext
Headersarray
Languagetext
Nametext
Request Objecttext
Metaobject
Actiontext
Modeltext
Model idtext
Revisionnumber

Create a Collection Webhook

ActionHook endpoint for running a collection.
Input fields[3]
FieldType
WorkspaceRequired
choice
CollectionRequired
choice
NameRequired
text
Environmentchoice
Output fields[3]
FieldType
Collectiontext
Nametext

Create a Folder Comment

ActionRemark attached to a folder.
Input fields[3]
FieldType
CollectionRequired
choice
Folder IDRequired
text
CommentRequired
text
Thread IDnumber
Tagged Usersarray
Userobject
Output fields[3]
FieldType
Bodytext
Tagsobject
@alex-cruzobject

Create a Mock Response

ActionCanned reply for a mock server.
Input fields[3]
FieldType
Mock ServerRequired
choice
NameRequired
text
Status CodeRequired
number
Headersarray
Rowobject
Languagechoice
Bodytext
Output fields[3]
FieldType
Server Responseobject
Nametext
Status Codenumber
Headersarray
Languagetext
Bodytext

Create a Mock Server

ActionFake API backed by a collection.
Input fields[3]
FieldType
WorkspaceRequired
choice
CollectionRequired
choice
Environmentchoice
Nametext
Privateboolean
Output fields[3]
FieldType
Idtext
Ownertext
Uidtext
Collectiontext
Mock Urltext
Nametext
Configobject
Headersarray
Match Bodyboolean
Match Headerboolean
Match Query Paramsboolean
Match Wildcardsboolean
Server Response Idtext
Created Atdate

2other output fields

Create a Monitor

ActionRecurring collection run with alerts.
Input fields[3]
FieldType
WorkspaceRequired
choice
NameRequired
text
CollectionRequired
choice
CronRequired
text
Time ZoneRequired
text
Environmentchoice
Activeboolean
Notification Limitnumber

8other input fields

Output fields[3]
FieldType
Idtext
Nametext
Activeboolean
Uidtext

Create a Request Comment

ActionTeam feedback on a single HTTP call.
Input fields[3]
FieldType
CollectionRequired
choice
Request IDRequired
text
CommentRequired
text
Thread IDnumber
Tagged Usersarray
Userobject
Output fields[3]
FieldType
Bodytext
Tagsobject
@alex-cruzobject

Create a Response Comment

ActionFeedback on a stored example.
Input fields[3]
FieldType
CollectionRequired
choice
Response IDRequired
text
CommentRequired
text
Thread IDnumber
Tagged Usersarray
Userobject
Output fields[3]
FieldType
Bodytext
Tagsobject
@alex-cruzobject

Create a Spec

ActionAPI spec from your own files.
Input fields[3]
FieldType
WorkspaceRequired
choice
NameRequired
text
TypeRequired
choice
FilesRequired
array
Fileobject
Output fields[3]
FieldType
Nametext
Typetext
Filesarray

Create a Spec File

ActionExtra document in an API spec.
Input fields[3]
FieldType
SpecRequired
choice
PathRequired
text
ContentRequired
text
Output fields[3]
FieldType
Created Atdate
Created Bynumber
Idtext
Pathtext
Updated Atdate
Updated Bynumber
Typetext

Create a Spec Version Tag

ActionLabeled checkpoint for a spec.
Input fields[3]
FieldType
SpecRequired
choice
NameRequired
text
Output fields[3]
FieldType
Nametext

Create a Workspace

ActionShared space for collections and specs.
Input fields[3]
FieldType
NameRequired
text
TypeRequired
choice
Descriptiontext
Abouttext
Teamchoice
Output fields[3]
FieldType
Nametext
Typetext
Descriptiontext
Abouttext

Create a Workspace Update

ActionFeed post for workspace members.
Input fields[3]
FieldType
WorkspaceRequired
choice
TopicRequired
text
DescriptionRequired
text
CategoryRequired
choice
Related Resourcesarray
Resourceobject
Output fields[3]
FieldType
Descriptiontext
Topictext
Categorytext
Related Resourcesarray

Create an API

ActionFresh API entry for your team.
Input fields[3]
FieldType
WorkspaceRequired
choice
NameRequired
text
Summarytext
Descriptiontext
Output fields[3]
FieldType
Nametext
Summarytext
Descriptiontext

Create an API Version

ActionRelease snapshot of an API.
Input fields[3]
FieldType
APIRequired
choice
NameRequired
text
Schema IDsarray
Collection IDsarray
Release Notestext
Output fields[3]
FieldType
Collectionsarray
Nametext
Release Notestext
Schemasarray

Create an Environment

ActionVariable set for a workspace.
Input fields[3]
FieldType
WorkspaceRequired
choice
NameRequired
text
Variablesarray
Variableobject
Output fields[3]
FieldType
Nametext
Valuesarray

Delete a Collection

ActionWhole collection gone for the team.
Input fields[3]
FieldType
CollectionRequired
choice
Output fields[3]
FieldType
Successboolean

Delete a Collection Comment

ActionClears one remark from a collection.
Input fields[3]
FieldType
CollectionRequired
choice
Comment IDRequired
text
Output fields[3]
FieldType
Successboolean

Delete a Collection Folder

ActionClears a folder out of a collection.
Input fields[3]
FieldType
CollectionRequired
choice
Folder IDRequired
text
Output fields[3]
FieldType
Successboolean

Delete a Collection Request

ActionClears one saved request.
Input fields[3]
FieldType
CollectionRequired
choice
Request IDRequired
text
Output fields[3]
FieldType
Successboolean

Delete a Collection Response

ActionClears a stored sample reply.
Input fields[3]
FieldType
CollectionRequired
choice
Response IDRequired
text
Output fields[3]
FieldType
Successboolean

Delete a Folder Comment

ActionClears a remark from a folder.
Input fields[3]
FieldType
CollectionRequired
choice
Folder IDRequired
text
Comment IDRequired
text
Output fields[3]
FieldType
Successboolean

Delete a Mock Response

ActionClears one canned mock reply.
Input fields[3]
FieldType
Mock ServerRequired
choice
Server Response IDRequired
text
Output fields[3]
FieldType
Successboolean

Delete a Mock Server

ActionFake API endpoint taken down.
Input fields[3]
FieldType
Mock ServerRequired
choice
Output fields[3]
FieldType
Successboolean

Delete a Monitor

ActionRecurring collection run cancelled.
Input fields[3]
FieldType
MonitorRequired
choice
Output fields[3]
FieldType
Successboolean

Delete a Request Comment

ActionStrips a remark from a request.
Input fields[3]
FieldType
CollectionRequired
choice
Request IDRequired
text
Comment IDRequired
text
Output fields[3]
FieldType
Successboolean

Delete a Response Comment

ActionStrips a remark from a sample reply.
Input fields[3]
FieldType
CollectionRequired
choice
Response IDRequired
text
Comment IDRequired
text
Output fields[3]
FieldType
Successboolean

Delete a Spec

ActionAPI spec removed from the workspace.
Input fields[3]
FieldType
SpecRequired
choice
Output fields[3]
FieldType
Successboolean

Delete a Spec File

ActionClears one document from a spec.
Input fields[3]
FieldType
SpecRequired
choice
File PathRequired
text
Output fields[3]
FieldType
Successboolean

Delete a Workspace

ActionEntire workspace shut down.
Input fields[3]
FieldType
WorkspaceRequired
choice
Confirmboolean
Output fields[3]
FieldType
Successboolean

Delete a Workspace Update

ActionPulls a post from the workspace feed.
Input fields[3]
FieldType
WorkspaceRequired
choice
Update IDRequired
text
Output fields[3]
FieldType
Successboolean

Delete an API

ActionRemoves one API from a workspace.
Input fields[3]
FieldType
APIRequired
choice
Output fields[3]
FieldType
Successboolean

Delete an API Version

ActionTrims the release history of an API.
Input fields[3]
FieldType
APIRequired
choice
Version IDRequired
text
Output fields[3]
FieldType
Successboolean

Delete an Environment

ActionVariable set removed from the workspace.
Input fields[3]
FieldType
EnvironmentRequired
choice
Output fields[3]
FieldType
Successboolean

Duplicate a Collection

ActionCloned collection in another workspace.
Input fields[3]
FieldType
CollectionRequired
choice
WorkspaceRequired
choice
Suffixtext
Output fields[3]
FieldType
Workspacetext
Suffixtext

Fork a Collection

ActionLinked copy that can merge back.
Input fields[3]
FieldType
CollectionRequired
choice
WorkspaceRequired
choice
LabelRequired
text
Output fields[3]
FieldType
Labeltext

Fork an Environment

ActionLinked environment copy for edits.
Input fields[3]
FieldType
EnvironmentRequired
choice
WorkspaceRequired
choice
Fork NameRequired
text
Output fields[3]
FieldType
Fork Nametext

Generate a Collection from a Spec

ActionTurns an API spec into requests.
Input fields[3]
FieldType
SpecRequired
choice
NameRequired
text
Request Name Sourcechoice
Indent Characterchoice
Folder Strategychoice
Include Auth Info in Exampleboolean
Enable Optional Parametersboolean
Keep Implicit Headersboolean

3other input fields

Output fields[3]
FieldType
Task Idtext
Urltext

Generate a Spec from a Collection

ActionDerives a spec from saved requests.
Input fields[3]
FieldType
CollectionRequired
choice
NameRequired
text
Typechoice
Formatchoice
Output fields[3]
FieldType
Task Idtext
Urltext

Make an API Call

universalYour own Postman REST API request.
Input fields[3]
FieldType
URLRequired
text
MethodRequired
choice
Headersarray
Rowobject
Query Stringarray
Rowobject
Bodytext
Output fields[3]
FieldType
Bodytext
Headersobject
Content-typetext
Status Codenumber

Merge a Collection Fork

ActionBrings a fork back into its original.
Input fields[3]
FieldType
SourceRequired
choice
DestinationRequired
choice
StrategyRequired
choice
Output fields[3]
FieldType
Strategytext
Sourcetext
Destinationtext

Merge an Environment Fork

ActionReunites an environment fork with its parent.
Input fields[3]
FieldType
EnvironmentRequired
choice
SourceRequired
choice
Delete Sourceboolean
Output fields[3]
FieldType
Sourcetext
Delete Sourceboolean

Publish a Mock Server

ActionMakes a mock server available to others.
Input fields[3]
FieldType
Mock ServerRequired
choice
Output fields[3]
FieldType
Mockobject
Idtext

Publish the Collection Documentation

ActionPuts collection docs on the web.
Input fields[3]
FieldType
CollectionRequired
choice
Top Bar ColorRequired
text
Right Sidebar ColorRequired
text
Highlight ColorRequired
text
Customization (JSON)Required
text
Environmentchoice
Layoutchoice
Output fields[3]
FieldType
Custom Colorobject
Highlighttext
Right Sidebartext
Top Bartext
Customizationobject
Meta Tagsarray
Appearanceobject
Environment Uidtext
Documentation Layouttext

Pull Collection Changes

ActionRefreshes a fork from upstream.
Input fields[3]
FieldType
CollectionRequired
choice
Output fields[3]
FieldType
Collectionobject
Destination Idtext
Source Idtext

Pull Environment Changes

ActionRefreshes an environment fork.
Input fields[3]
FieldType
EnvironmentRequired
choice
SourceRequired
choice
Output fields[3]
FieldType
Sourcetext

Remove an Environment Variable

ActionStrips one variable out of the set.
Input fields[3]
FieldType
EnvironmentRequired
choice
KeyRequired
text
Output fields[3]
FieldType
Environmentobject
Idtext
Nametext
Ownertext
Created Atdate
Updated Atdate
Valuesarray
Uidtext

Rename a Spec

ActionNew title for an API spec.
Input fields[3]
FieldType
SpecRequired
choice
NameRequired
text
Output fields[3]
FieldType
Idtext
Typetext
Created Bynumber
Updated Bynumber
Created Atdate
Updated Atdate
Nametext

Rename an Environment

ActionNew title for an existing variable set.
Input fields[3]
FieldType
EnvironmentRequired
choice
NameRequired
text
Output fields[3]
FieldType
Environmentobject
Idtext
Nametext
Ownertext
Created Atdate
Updated Atdate
Valuesarray
Uidtext

Replace a Collection

ActionSwaps in a new collection body.
Input fields[3]
FieldType
CollectionRequired
choice
Collection (JSON)Required
text
Run Asyncboolean
Output fields[3]
FieldType
Idtext
Nametext
Uidtext

Replace an Environment

ActionSwaps in a new variable set.
Input fields[3]
FieldType
EnvironmentRequired
choice
Nametext
Variablesarray
Variableobject
Confirmboolean
Output fields[3]
FieldType
Nametext
Valuesarray

Replace Workspace Variables

ActionSwaps in new global variables.
Input fields[3]
FieldType
WorkspaceRequired
choice
Variablesarray
Variableobject
Confirmboolean
Output fields[3]
FieldType
Valuesarray

Resolve a Comment Thread

ActionCloses out a discussion thread.
Input fields[3]
FieldType
Thread IDRequired
text
Output fields[3]
FieldType
Successboolean

Review a Pull Request

ActionRecords a decision on a merge proposal.
Input fields[3]
FieldType
Pull Request IDRequired
text
ActionRequired
choice
Commenttext
Output fields[3]
FieldType
Idtext
Reviewed Byobject
Idnumber
Nametext
Usernametext
Statustext
Updated Atdate

Run a Monitor

ActionKicks off a monitor run now.
Input fields[3]
FieldType
MonitorRequired
choice
Run in the Backgroundboolean
Output fields[3]
FieldType
Infoobject
Job Idtext
Collection Uidtext
Environment Uidtext
Monitor Idtext
Nametext
Statustext
Started Atdate
Finished Atdate

Set an Environment Variable

ActionAdds or edits a single variable.
Input fields[3]
FieldType
EnvironmentRequired
choice
KeyRequired
text
Valuetext
Typechoice
Enabledchoice
Descriptiontext
Output fields[3]
FieldType
Environmentobject
Idtext
Nametext
Ownertext
Created Atdate
Updated Atdate
Valuesarray
Uidtext

Set Collection Tags

ActionOverwrites the tag list on a collection.
Input fields[3]
FieldType
CollectionRequired
choice
Tagsarray
Confirmboolean
Output fields[3]
FieldType
Tagsarray

Set Workspace Tags

ActionRe-labels a workspace.
Input fields[3]
FieldType
WorkspaceRequired
choice
Tagsarray
Confirmboolean
Output fields[3]
FieldType
Tagsarray

Sync a Collection with a Spec

ActionMakes a collection follow its spec.
Input fields[3]
FieldType
CollectionRequired
choice
Spec IDRequired
text
Output fields[3]
FieldType
Task Idtext
Urltext

Sync a Spec with a Collection

ActionBrings an API definition up to date.
Input fields[3]
FieldType
SpecRequired
choice
CollectionRequired
choice
Output fields[3]
FieldType
Task Idtext
Urltext

Transfer Collection Folders

ActionRelocate or duplicate folders in a collection.
Input fields[3]
FieldType
IDsRequired
array
ModeRequired
choice
Target IDRequired
text
Target KindRequired
choice
PositionRequired
choice
Location IDtext
Output fields[3]
FieldType
Idsarray

Transfer Collection Requests

ActionShift or clone requests between targets.
Input fields[3]
FieldType
IDsRequired
array
ModeRequired
choice
Target IDRequired
text
Target KindRequired
choice
PositionRequired
choice
Location IDtext
Output fields[3]
FieldType
Idsarray

Transfer Workspace Elements

ActionRelocates items across workspaces.
Input fields[3]
FieldType
WorkspaceRequired
choice
Element IDsRequired
array
TypeRequired
choice
Target WorkspaceRequired
choice
Output fields[3]
FieldType
Idtext
Typetext
Totext

Unpublish a Mock Server

ActionWithdraws a published mock server.
Input fields[3]
FieldType
Mock ServerRequired
choice
Output fields[3]
FieldType
Mockobject
Idtext

Unpublish the Collection Documentation

ActionStops sharing collection docs.
Input fields[3]
FieldType
CollectionRequired
choice
Output fields[3]
FieldType
Successboolean

Update a Collection

ActionAlters collection settings and scripts.
Input fields[3]
FieldType
CollectionRequired
choice
Nametext
Descriptiontext
Variablesarray
Variableobject
Auth (JSON)text
Events (JSON)text
Output fields[3]
FieldType
Idtext
Nametext
Descriptiontext

Update a Collection Comment

ActionReworded remark on a collection.
Input fields[3]
FieldType
CollectionRequired
choice
Comment IDRequired
text
CommentRequired
text
Tagged Usersarray
Userobject
Output fields[3]
FieldType
Bodytext
Tagsobject
@alex-cruzobject

Update a Collection Folder

ActionRetitles or redescribes a folder.
Input fields[3]
FieldType
CollectionRequired
choice
Folder IDRequired
text
Nametext
Descriptiontext
Output fields[3]
FieldType
Dataobject
Idtext
Nametext
Descriptiontext
Created Atdate
Updated Atdate
Ownertext
Last Updated Bytext
Last Revisionnumber
Collectiontext
Foldertext
Metaobject
Actiontext
Modeltext
Model idtext
Revisionnumber

Update a Collection Request

ActionRewrites a saved request.
Input fields[3]
FieldType
CollectionRequired
choice
Request IDRequired
text
Nametext
Methodchoice
URLtext
Descriptiontext
Headersarray
Rowobject
Query Parametersarray
Rowobject

8other input fields

Output fields[3]
FieldType
Dataobject
Idtext
Nametext
Descriptiontext
Created Atdate
Updated Atdate
Ownertext
Last Updated Bytext
Last Revisionnumber
Authtext
Collectiontext
Metaobject
Actiontext
Modeltext
Model idtext
Revisionnumber

Update a Collection Response

ActionTweaks a saved sample reply.
Input fields[3]
FieldType
CollectionRequired
choice
Response IDRequired
text
Nametext
URLtext
Methodchoice
Status Codenumber
Status Texttext
Headersarray
Rowobject

4other input fields

Output fields[3]
FieldType
Nametext
Headersobject
0object
1object
2object
3object
Response Codeobject
Codenumber
Nametext
Statustext
Timetext
Cookiestext
Mimetext
Texttext

9other output fields

Update a Folder Comment

ActionRewords a folder remark.
Input fields[3]
FieldType
CollectionRequired
choice
Folder IDRequired
text
Comment IDRequired
text
CommentRequired
text
Tagged Usersarray
Userobject
Output fields[3]
FieldType
Bodytext
Tagsobject
@alex-cruzobject

Update a Mock Response

ActionReshapes a canned mock reply.
Input fields[3]
FieldType
Mock ServerRequired
choice
Server Response IDRequired
text
Nametext
Status Codenumber
Headersarray
Rowobject
Languagechoice
Bodytext
Output fields[3]
FieldType
Server Responseobject
Nametext
Status Codenumber
Headersarray
Languagetext
Bodytext

Update a Mock Server

ActionChanges the settings of a fake API server.
Input fields[3]
FieldType
Mock ServerRequired
choice
Nametext
Environmentchoice
Collectionchoice
Descriptiontext
Privatechoice
Version Tagtext
Server Response IDtext

1other input field

Output fields[3]
FieldType
Idtext
Ownertext
Uidtext
Collectiontext
Mock Urltext
Nametext
Configobject
Headersarray
Match Bodyboolean
Match Headerboolean
Match Query Paramsboolean
Match Wildcardsboolean
Server Response Idtext
Created Atdate

2other output fields

Update a Monitor

ActionAdjusts a scheduled run.
Input fields[3]
FieldType
MonitorRequired
choice
Nametext
Crontext
Time Zonetext
Activechoice
Notification Limitnumber
Retry Attemptsnumber
Email on Errorarray

7other input fields

Output fields[3]
FieldType
Activeboolean

Update a Request Comment

ActionRewrites feedback on a request.
Input fields[3]
FieldType
CollectionRequired
choice
Request IDRequired
text
Comment IDRequired
text
CommentRequired
text
Tagged Usersarray
Userobject
Output fields[3]
FieldType
Bodytext
Tagsobject
@alex-cruzobject

Update a Response Comment

ActionEdits a sample reply remark.
Input fields[3]
FieldType
CollectionRequired
choice
Response IDRequired
text
Comment IDRequired
text
CommentRequired
text
Tagged Usersarray
Userobject
Output fields[3]
FieldType
Bodytext
Tagsobject
@alex-cruzobject

Update a Spec File

ActionRewrites a spec document.
Input fields[3]
FieldType
SpecRequired
choice
File PathRequired
text
Nametext
Typechoice
Contenttext
Output fields[3]
FieldType
Created Atdate
Created Bynumber
Idtext
Pathtext
Updated Atdate
Updated Bynumber
Typetext

Update a Workspace

ActionAdjusts the settings of a workspace.
Input fields[3]
FieldType
WorkspaceRequired
choice
Nametext
Typechoice
Descriptiontext
Abouttext
Clear Fieldschoice
Output fields[3]
FieldType
Nametext
Typetext
Descriptiontext
Abouttext

Update a Workspace Update

ActionEdits a feed post.
Input fields[3]
FieldType
WorkspaceRequired
choice
Update IDRequired
text
TopicRequired
text
DescriptionRequired
text
CategoryRequired
choice
Related Resourcesarray
Resourceobject
Pinnedchoice
Output fields[3]
FieldType
Descriptiontext
Topictext
Categorytext
Is Pinnedboolean
Related Resourcesarray

Update an API

ActionAdjusts the metadata of an API.
Input fields[3]
FieldType
APIRequired
choice
Nametext
Summarytext
Descriptiontext
Output fields[3]
FieldType
Nametext
Summarytext
Descriptiontext

Update an API Version

ActionRewords a release entry.
Input fields[3]
FieldType
APIRequired
choice
Version IDRequired
text
NameRequired
text
Release Notestext
Output fields[3]
FieldType
Nametext
Release Notestext

Update Spec Sync Options

ActionSync rules between spec and collection.
Input fields[3]
FieldType
SpecRequired
choice
CollectionRequired
choice
Sync Exampleschoice
Delete Orphaned Requestschoice
Output fields[3]
FieldType
Sync Optionsobject
Sync Examplesboolean
Delete Orphaned Requestsboolean

Look for Postman templates in the WEXTL template library.

Browse templates →
  1. WEXTL® Postman Source Code connector implementation.
  2. Our users use cases and automations.
  3. Official API Documentation for Postman.
  4. WEXTL® visual workflow builder data.

Last updated: Nov 14, 2026 14:55

How we write our apps documentation

How we compile these docs: sources, the role of AI, and how we verify.