Postman integration guide
VerifiedHow 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].
Requirements
Get your Postman credentials
Connect Postman in WEXTL
- Log in to your WEXTL account, add the Postman node module to your workflow, and click Create new credential.
- Optional: In the Credential name field, enter a name for the credential.
- Enter the authentication credentials you copied from your Postman account, or follow the on-screen instructions to create the credential.
- If prompted, authenticate your account and confirm access.
- If you want to make changes to your credential in the future, follow the steps in Manage credentials →
Postman triggers and actions on WEXTL
The list below is a reference of every Postman node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.
Browse every Postman node module below. Each one opens to show its input parameters, outputs, and connection requirements.
Watch Mock Calls
TriggerScheduled mock traffic check.
| Field | Type |
|---|---|
Mock ServerRequired | choice |
| Limit | number |
| Field | Type |
|---|---|
| Id | text |
| Response Name | text |
| Served At | date |
| Request | object |
| Method | text |
| Path | text |
| Response | object |
| Type | text |
| Status Code | number |
Watch Monitor Runs
TriggerScheduled run history check.
| Field | Type |
|---|---|
MonitorRequired | choice |
| Limit | number |
| Field | Type |
|---|---|
| Monitor Id | text |
| Monitor Uid | text |
| Name | text |
| Status | text |
| Started At | date |
| Finished At | date |
| Stats | object |
| Assertions | object |
Watch Workspace Activity
TriggerChecks the activity feed at set intervals.
| Field | Type |
|---|---|
WorkspaceRequired | choice |
| Element Type | choice |
| Limit | number |
| Field | Type |
|---|---|
| Workspace Id | text |
| Created At | date |
| Updated At | date |
| Id | number |
| User | object |
| Id | number |
| Username | text |
| Is Partner | boolean |
| Name | text |
| Action | text |
| Element Type | text |
| Trigger | text |
2other output fields
Get a Collection
ActionComplete collection definition as JSON.
| Field | Type |
|---|---|
CollectionRequired | choice |
| Model | choice |
| Access Key | text |
| Field | Type |
|---|---|
| Info | object |
| postman id | text |
| Name | text |
| Description | text |
| Schema | text |
| Updated At | date |
| Uid | text |
| Created At | date |
| Last Updated By | text |
| Item | array |
| Auth | object |
| Type | text |
| Apikey | array |
| Event | object |
| 0 | object |
| 1 | object |
| Variable | object |
| 0 | object |
Get a Collection Folder
ActionFolder ownership and contents.
| Field | Type |
|---|---|
CollectionRequired | choice |
Folder IDRequired | text |
| Populate | boolean |
| Field | Type |
|---|---|
| Id | text |
| Name | text |
| Description | text |
| Created At | date |
| Updated At | date |
| Owner | text |
| Collection | text |
| Auth | object |
| Apikey | array |
| Type | text |
5other output fields
Get a Collection Merge Status
ActionHow far a merge has progressed.
| Field | Type |
|---|---|
Task IDRequired | text |
| Field | Type |
|---|---|
| Id | text |
| Status | text |
Get a Collection Request
ActionSaved call with ownership and revision.
| Field | Type |
|---|---|
CollectionRequired | choice |
Request IDRequired | text |
| Populate | boolean |
| Field | Type |
|---|---|
| Id | text |
| Name | text |
| Owner | text |
| Last Revision | number |
| Last Updated By | text |
| Created At | date |
| Updated At | date |
| Auth | text |
23other output fields
Get a Collection Response
ActionSample reply with its parent request.
| Field | Type |
|---|---|
CollectionRequired | choice |
Response IDRequired | text |
| Field | Type |
|---|---|
| Id | text |
| Request | text |
| Name | text |
| Owner | text |
| Created At | date |
| Updated At | date |
| Last Revision | number |
| Last Updated By | text |
10other output fields
Get a Collection Update Status
ActionProgress of a running update job.
| Field | Type |
|---|---|
Task IDRequired | text |
| Field | Type |
|---|---|
| Id | text |
| Status | text |
Get a Duplicate Collection Status
ActionProgress of a running copy job.
| Field | Type |
|---|---|
Task IDRequired | text |
| Field | Type |
|---|---|
| Task | object |
| Id | text |
| Status | text |
| Reason | text |
Get a Mock Response
ActionDetails of a canned reply.
| Field | Type |
|---|---|
Mock ServerRequired | choice |
Server Response IDRequired | text |
| Field | Type |
|---|---|
| Created At | date |
| Updated At | date |
| Id | text |
| Name | text |
| Status Code | number |
| Headers | array |
| Body | text |
| Created By | text |
2other output fields
Get a Mock Server
ActionMock server details and URL.
| Field | Type |
|---|---|
Mock ServerRequired | choice |
| Field | Type |
|---|---|
| Id | text |
| Owner | text |
| Uid | text |
| Collection | text |
| Mock Url | text |
| Name | text |
| Config | object |
| Delay | object |
| Headers | array |
| Match Body | boolean |
| Match Header | boolean |
| Match Query Params | boolean |
| Match Wildcards | boolean |
| Server Response Id | text |
| Created At | date |
4other output fields
Get a Monitor
ActionSettings of a scheduled run.
| Field | Type |
|---|---|
MonitorRequired | choice |
| Field | Type |
|---|---|
| Id | text |
| Name | text |
| Uid | text |
| Owner | number |
| Active | boolean |
| Notification Limit | number |
| Collection Uid | text |
| Environment Uid | text |
6other output fields
Get a Pull Request
ActionMerge proposal with author and text.
| Field | Type |
|---|---|
Pull Request IDRequired | text |
| Field | Type |
|---|---|
| Created At | date |
| Updated At | date |
| Id | text |
| Title | text |
| Description | text |
| Created By | text |
| Updated By | text |
| Comment | text |
6other output fields
Get a Source Collection Status
ActionFork drift against the source.
| Field | Type |
|---|---|
CollectionRequired | choice |
| Field | Type |
|---|---|
| Collection | object |
| 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 | object |
Get a Spec
ActionFormat and author of an API spec.
| Field | Type |
|---|---|
SpecRequired | choice |
| Field | Type |
|---|---|
| Id | text |
| File Format | text |
| Name | text |
| Type | text |
| Created By | number |
| Updated By | number |
| Created At | date |
| Updated At | date |
Get a Spec Definition
ActionParsed body of an API spec.
| Field | Type |
|---|---|
SpecRequired | choice |
| Field | Type |
|---|---|
| Components | object |
| Security Schemes | object |
| Info | object |
| Contact | object |
| Description | text |
| Title | text |
| Version | text |
| Openapi | text |
| Paths | object |
| /spacecrafts/{spacecraft Id} | object |
| Security | array |
| Servers | array |
Get a Spec File
ActionDocument inside a spec, with authorship.
| Field | Type |
|---|---|
SpecRequired | choice |
File PathRequired | text |
| Field | Type |
|---|---|
| Id | text |
| Name | text |
| Path | text |
| Created By | number |
| Updated By | number |
| Created At | date |
| Updated At | date |
| Type | text |
1other output field
Get a Spec Task Status
ActionProgress report on a spec job.
| Field | Type |
|---|---|
Element TypeRequired | choice |
Element IDRequired | text |
Task IDRequired | text |
| Field | Type |
|---|---|
| Meta | object |
| Action | text |
| Model | text |
| Status | text |
Get a Team
ActionHandle and profile of your team.
| Field | Type |
|---|---|
TeamRequired | choice |
| Include | choice |
| Field | Type |
|---|---|
| Created At | date |
| Updated At | date |
| Id | number |
| Name | text |
| Handle | text |
| Description | text |
| Organization Id | number |
| Created By | number |
1other output field
Get a Team User
ActionProfile of one member.
| Field | Type |
|---|---|
User IDRequired | text |
| Field | Type |
|---|---|
| Id | number |
| Name | text |
| Username | text |
| text | |
| Roles | array |
| Joined At | date |
Get a Workspace
ActionType, visibility and creator of a workspace.
| Field | Type |
|---|---|
WorkspaceRequired | choice |
| Field | Type |
|---|---|
| Id | text |
| Name | text |
| Type | text |
| Description | text |
| Visibility | text |
| Created By | text |
| Updated By | text |
| Created At | date |
8other output fields
Get a Workspace Update
ActionSingle post from the feed.
| Field | Type |
|---|---|
WorkspaceRequired | choice |
Update IDRequired | text |
| Field | Type |
|---|---|
| Id | number |
| Topic | text |
| Description | text |
| Workspace Id | text |
| Created By | object |
| Id | number |
| Name | text |
| Username | text |
| Updated By | number |
| Created At | date |
| Updated At | date |
3other output fields
Get an API
ActionFull profile of one API.
| Field | Type |
|---|---|
APIRequired | choice |
| Include | choice |
| Field | Type |
|---|---|
| Collections | array |
| Created At | date |
| Created By | number |
| Description | text |
| Git Info | text |
| Id | text |
| Name | text |
| Schemas | array |
4other output fields
Get an API Schema
ActionContents of one API schema, merged on request.
| Field | Type |
|---|---|
APIRequired | choice |
Schema IDRequired | text |
| Version ID | text |
| Bundled | boolean |
| Field | Type |
|---|---|
| Created At | date |
| Files | object |
| Data | array |
| Meta | object |
| Updated At | date |
Get an API Schema File
ActionRaw content of a schema file.
| Field | Type |
|---|---|
APIRequired | choice |
Schema IDRequired | text |
File PathRequired | text |
| Version ID | text |
| Field | Type |
|---|---|
| Id | text |
| Name | text |
| Path | text |
| Content | text |
| Created At | date |
| Created By | text |
| Updated At | date |
| Updated By | text |
Get an API Version
ActionOne named API release.
| Field | Type |
|---|---|
APIRequired | choice |
Version IDRequired | text |
| Field | Type |
|---|---|
| Version | object |
| Id | text |
| Name | text |
| Created At | date |
| Updated At | date |
| Release Notes | text |
| Schemas | array |
| Collections | array |
Get an Environment
ActionVariables and owner of an environment.
| Field | Type |
|---|---|
EnvironmentRequired | choice |
| Field | Type |
|---|---|
| Id | text |
| Name | text |
| Owner | text |
| Created At | date |
| Updated At | date |
| Values | array |
| Is Public | boolean |
Get Collection Tags
ActionLabels currently on a collection.
| Field | Type |
|---|---|
CollectionRequired | choice |
| Field | Type |
|---|---|
| Tags | array |
Get Spec Version Files
ActionFrozen file set of a tagged spec.
| Field | Type |
|---|---|
SpecRequired | choice |
Tag IDRequired | text |
| Field | Type |
|---|---|
| Data | array |
Get the Current User
ActionAccount behind your API key.
| Field | Type |
|---|---|
| User | object |
| Id | number |
| Sub | text |
| Username | text |
| text | |
| Full Name | text |
| Avatar | text |
| Is Public | boolean |
| Email Verified | boolean |
| Team Id | number |
| Team Name | text |
| Operations | array |
Get Workspace Tags
ActionLabels assigned to a workspace.
| Field | Type |
|---|---|
WorkspaceRequired | choice |
| Field | Type |
|---|---|
| Tags | array |
Get Workspace Variables
ActionShared values defined for a workspace.
| Field | Type |
|---|---|
WorkspaceRequired | choice |
| Field | Type |
|---|---|
| Values | array |
List API Schema Files
SearchDocuments bundled in a schema.
| Field | Type |
|---|---|
APIRequired | choice |
Schema IDRequired | text |
| Version ID | text |
| Limit | number |
| Field | Type |
|---|---|
| Id | text |
| Name | text |
| Path | text |
| Created At | date |
| Created By | number |
| Updated At | date |
| Updated By | number |
List API Versions
SearchRelease history of an API.
| Field | Type |
|---|---|
APIRequired | choice |
| Limit | number |
| Field | Type |
|---|---|
| Id | text |
| Name | text |
| Created At | date |
| Updated At | date |
| Release Notes | text |
List APIs
SearchAPI catalog of a workspace.
| Field | Type |
|---|---|
WorkspaceRequired | choice |
| Created By | number |
| Description | text |
| Limit | number |
| Field | Type |
|---|---|
| Id | text |
| Name | text |
| Summary | text |
| Created At | date |
| Created By | number |
| Updated At | date |
| Updated By | number |
| Description | text |
List Collection Comments
SearchDiscussion posted on a collection.
| Field | Type |
|---|---|
CollectionRequired | choice |
| Limit | number |
| Field | Type |
|---|---|
| Id | number |
| Thread Id | number |
| Status | text |
| Created By | number |
| Created At | date |
| Updated At | date |
| Body | text |
List Collection Forks
SearchCopies branched from a collection.
| Field | Type |
|---|---|
CollectionRequired | choice |
| Direction | choice |
| Limit | number |
| Field | Type |
|---|---|
| Created At | date |
| Created By | text |
| Fork Id | text |
| Fork Name | text |
List Collection Pull Requests
SearchMerge proposals for a collection.
| Field | Type |
|---|---|
CollectionRequired | choice |
| Limit | number |
| Field | Type |
|---|---|
| Created At | date |
| Created By | text |
| Description | text |
| Destination Id | text |
| Href | text |
| Id | text |
| Source Id | text |
| Status | text |
3other output fields
List Collection Specs
SearchAPI definitions created from one collection.
| Field | Type |
|---|---|
CollectionRequired | choice |
| Limit | number |
| Field | Type |
|---|---|
| Id | text |
| Name | text |
| State | text |
| Created At | date |
| Updated At | date |
| Created By | number |
| Updated By | number |
List Collections
SearchEvery collection your account can open.
| Field | Type |
|---|---|
| Workspace | choice |
| Name | text |
| Limit | number |
| Field | Type |
|---|---|
| Id | text |
| Name | text |
| Owner | text |
| Created At | date |
| Updated At | date |
| Uid | text |
| Is Public | boolean |
List Environment Forks
SearchCopies branched from an environment.
| Field | Type |
|---|---|
EnvironmentRequired | choice |
| Direction | choice |
| Limit | number |
| Field | Type |
|---|---|
| Fork Id | text |
| Fork Name | text |
| Created At | date |
| Created By | text |
| Updated At | date |
List Environments
SearchEnvironments across your account.
| Field | Type |
|---|---|
| Workspace | choice |
| Limit | number |
| Field | Type |
|---|---|
| Id | text |
| Name | text |
| Created At | date |
| Updated At | date |
| Owner | text |
| Uid | text |
| Is Public | boolean |
List Folder Comments
SearchConversation under a folder.
| Field | Type |
|---|---|
CollectionRequired | choice |
Folder IDRequired | text |
| Limit | number |
| Field | Type |
|---|---|
| Id | number |
| Thread Id | number |
| Status | text |
| Created By | number |
| Created At | date |
| Updated At | date |
| Body | text |
List Forked Collections
SearchYour own forks of other collections.
| Field | Type |
|---|---|
| Direction | choice |
| Limit | number |
| Field | Type |
|---|---|
| Fork Name | text |
| Fork Id | text |
| Source Id | text |
| Created At | date |
List Mock Calls
SearchTraffic log of a mock server.
| Field | Type |
|---|---|
Mock ServerRequired | choice |
| Since | date |
| Until | date |
| Status Code | number |
| Response Type | text |
| Method | choice |
| Path | text |
| Direction | choice |
1other input field
| Field | Type |
|---|---|
| Id | text |
| Response Name | text |
| Served At | date |
| Request | object |
| Method | text |
| Path | text |
| Response | object |
| Type | text |
| Status Code | number |
List Mock Responses
SearchCanned replies on a mock.
| Field | Type |
|---|---|
Mock ServerRequired | choice |
| Limit | number |
| Field | Type |
|---|---|
| Id | text |
| Name | text |
| Status Code | number |
| Created At | date |
| Updated At | date |
| Created By | text |
| Updated By | text |
List Mock Servers
SearchFake APIs configured on your account.
| Field | Type |
|---|---|
| Team | choice |
| Workspace | choice |
| Limit | number |
| Field | Type |
|---|---|
| Id | text |
| Owner | text |
| Uid | text |
| Collection | text |
| Mock Url | text |
| Name | text |
| Config | object |
| Delay | object |
| Headers | array |
| Match Body | boolean |
| Match Header | boolean |
| Match Query Params | boolean |
| Match Wildcards | boolean |
| Server Response Id | text |
| Created At | date |
4other output fields
List Monitors
SearchScheduled runs in your account.
| Field | Type |
|---|---|
| Workspace | choice |
| Active | choice |
| Owner ID | number |
| Collection | choice |
| Environment | choice |
| Limit | number |
| Field | Type |
|---|---|
| Id | text |
| Name | text |
| Active | boolean |
| Uid | text |
| Owner | number |
| Collection Uid | text |
| Environment Uid | text |
List Request Comments
SearchFeedback left on a saved request.
| Field | Type |
|---|---|
CollectionRequired | choice |
Request IDRequired | text |
| Limit | number |
| Field | Type |
|---|---|
| Id | number |
| Thread Id | number |
| Status | text |
| Created By | number |
| Created At | date |
| Updated At | date |
| Body | text |
List Response Comments
SearchRemarks on a sample reply.
| Field | Type |
|---|---|
CollectionRequired | choice |
Response IDRequired | text |
| Limit | number |
| Field | Type |
|---|---|
| Id | number |
| Thread Id | number |
| Status | text |
| Created By | number |
| Created At | date |
| Updated At | date |
| Body | text |
List Spec Collections
SearchRequest sets generated from one spec.
| Field | Type |
|---|---|
SpecRequired | choice |
| Limit | number |
| Field | Type |
|---|---|
| Id | text |
| Name | text |
| State | text |
| Created At | date |
| Updated At | date |
| Created By | number |
List Spec Files
SearchDefinition files inside an API spec.
| Field | Type |
|---|---|
SpecRequired | choice |
| Limit | number |
| Field | Type |
|---|---|
| Id | text |
| Path | text |
| Name | text |
| Created By | number |
| Updated By | number |
| Created At | date |
| Updated At | date |
| Type | text |
List Spec Version Tags
SearchNamed checkpoints saved for a spec.
| Field | Type |
|---|---|
SpecRequired | choice |
| Limit | number |
| Field | Type |
|---|---|
| Id | text |
| Name | text |
List Specs
SearchAPI specs in a workspace.
| Field | Type |
|---|---|
WorkspaceRequired | choice |
| Limit | number |
| Field | Type |
|---|---|
| Id | text |
| Name | text |
| Type | text |
| Created By | number |
| Updated By | number |
| Created At | date |
| Updated At | date |
List Tagged Items
SearchEverything labeled with a tag.
| Field | Type |
|---|---|
TagRequired | text |
| Item Type | choice |
| Direction | choice |
| Limit | number |
| Field | Type |
|---|---|
| Data | object |
| Entities | array |
| Meta | object |
| Count | number |
List Team Users
SearchRoster with emails and roles.
| Field | Type |
|---|---|
| Group ID | number |
| Limit | number |
| Field | Type |
|---|---|
| Id | number |
| Name | text |
| Username | text |
| text | |
| Roles | array |
| Joined At | date |
List Teams
SearchHandles and descriptions of your teams.
| Field | Type |
|---|---|
| Include Settings | boolean |
| Include User Roles | boolean |
| Limit | number |
| Field | Type |
|---|---|
| Created At | date |
| Updated At | date |
| Id | number |
| Name | text |
| Handle | text |
| Description | text |
| Organization Id | number |
| Created By | number |
2other output fields
List Workspace Activity
SearchWho did what and when in a space.
| Field | Type |
|---|---|
WorkspaceRequired | choice |
| User ID | number |
| Element Type | choice |
| Limit | number |
| Field | Type |
|---|---|
| Workspace Id | text |
| Created At | date |
| Updated At | date |
| Id | number |
| User | object |
| Id | number |
| Username | text |
| Is Partner | boolean |
| Name | text |
| Action | text |
| Element Type | text |
| Trigger | text |
2other output fields
List Workspace Updates
SearchAnnouncements shared with workspace members.
| Field | Type |
|---|---|
WorkspaceRequired | choice |
| Category | choice |
| Limit | number |
| Field | Type |
|---|---|
| Id | number |
| Topic | text |
| Description | text |
| Workspace Id | text |
| Created By | object |
| Id | number |
| Name | text |
| Username | text |
| Updated By | number |
| Created At | date |
| Updated At | date |
3other output fields
List Workspaces
SearchSpaces your team organizes work in.
| Field | Type |
|---|---|
| Type | choice |
| Created By | number |
| Element Type | choice |
| Element ID | text |
| Include Deactivated Mocks | boolean |
| Limit | number |
| Field | Type |
|---|---|
| Id | text |
| Name | text |
| Type | text |
| Visibility | text |
| Created By | text |
| About | text |
| Created At | date |
| Updated At | date |
Search Postman
SearchCross-workspace content search.
| Field | Type |
|---|---|
Element TypeRequired | choice |
| Search | text |
| Ownership | choice |
| Filters (JSON) | text |
| Limit | number |
| Field | Type |
|---|---|
| Id | text |
| Name | text |
| Method | text |
| Description | text |
| Url | text |
| Created By | text |
| Team | object |
| Id | text |
| Name | text |
| Is Git Connected | boolean |
4other output fields
Add a Collection to an API
ActionLinks collection data to an API definition.
| Field | Type |
|---|---|
APIRequired | choice |
Operation TypeRequired | choice |
Data (JSON)Required | text |
| Field | Type |
|---|---|
| Data | object |
| Collection Id | text |
| Operation Type | text |
Create a Collection
ActionCollection ready for requests.
| Field | Type |
|---|---|
WorkspaceRequired | choice |
NameRequired | text |
| Description | text |
| Items (JSON) | text |
| Variables | array |
| Variable | object |
| Auth (JSON) | text |
| Events (JSON) | text |
| Field | Type |
|---|---|
| Id | text |
| Name | text |
| Uid | text |
Create a Collection Comment
ActionDiscussion note on a collection.
| Field | Type |
|---|---|
CollectionRequired | choice |
CommentRequired | text |
| Thread ID | number |
| Tagged Users | array |
| User | object |
| Field | Type |
|---|---|
| Body | text |
| Tags | object |
| @alex-cruz | object |
Create a Collection Folder
ActionOrganizes requests into a new group.
| Field | Type |
|---|---|
CollectionRequired | choice |
NameRequired | text |
| Parent Folder ID | text |
| Field | Type |
|---|---|
| Data | object |
| Id | text |
| Name | text |
| Order | array |
| Owner | text |
| Folder | text |
| Folders | array |
| Requests | array |
| Created At | date |
| Updated At | date |
| Collection | text |
| Meta | object |
| Action | text |
| Model | text |
| Model id | text |
| Revision | number |
Create a Collection Pull Request
ActionReview request for a forked collection.
| Field | Type |
|---|---|
CollectionRequired | choice |
TitleRequired | text |
DestinationRequired | choice |
ReviewersRequired | choice |
| Description | text |
| Field | Type |
|---|---|
| Created At | date |
| Created By | text |
| Description | text |
| Destination Id | text |
| Id | text |
| Source Id | text |
| Status | text |
| Title | text |
1other output field
Create a Collection Request
ActionStored HTTP call inside a collection.
| Field | Type |
|---|---|
CollectionRequired | choice |
| Folder ID | text |
| Name | text |
| Method | choice |
| URL | text |
| Description | text |
| Headers | array |
| Row | object |
| Query Parameters | array |
| Row | object |
7other input fields
| Field | Type |
|---|---|
| Data | object |
| Id | text |
| Name | text |
| Owner | text |
| Folder | text |
| Responses | array |
| Collection | text |
| Responses order | array |
| Created At | date |
| Updated At | date |
| Last Updated By | text |
| Meta | object |
| Action | text |
| Model | text |
| Model id | text |
| Revision | number |
Create a Collection Response
ActionSample reply saved on a request.
| Field | Type |
|---|---|
CollectionRequired | choice |
Request IDRequired | text |
| Name | text |
| URL | text |
| Method | choice |
| Status Code | number |
| Status Text | text |
| Headers | array |
| Row | object |
3other input fields
| Field | Type |
|---|---|
| Data | object |
| Id | text |
| Owner | text |
| Request | text |
| Created At | date |
| Updated At | date |
| Last Updated By | text |
| Headers | array |
| Language | text |
| Name | text |
| Request Object | text |
| Meta | object |
| Action | text |
| Model | text |
| Model id | text |
| Revision | number |
Create a Collection Webhook
ActionHook endpoint for running a collection.
| Field | Type |
|---|---|
WorkspaceRequired | choice |
CollectionRequired | choice |
NameRequired | text |
| Environment | choice |
| Field | Type |
|---|---|
| Collection | text |
| Name | text |
Create a Folder Comment
ActionRemark attached to a folder.
| Field | Type |
|---|---|
CollectionRequired | choice |
Folder IDRequired | text |
CommentRequired | text |
| Thread ID | number |
| Tagged Users | array |
| User | object |
| Field | Type |
|---|---|
| Body | text |
| Tags | object |
| @alex-cruz | object |
Create a Mock Response
ActionCanned reply for a mock server.
| Field | Type |
|---|---|
Mock ServerRequired | choice |
NameRequired | text |
Status CodeRequired | number |
| Headers | array |
| Row | object |
| Language | choice |
| Body | text |
| Field | Type |
|---|---|
| Server Response | object |
| Name | text |
| Status Code | number |
| Headers | array |
| Language | text |
| Body | text |
Create a Mock Server
ActionFake API backed by a collection.
| Field | Type |
|---|---|
WorkspaceRequired | choice |
CollectionRequired | choice |
| Environment | choice |
| Name | text |
| Private | boolean |
| Field | Type |
|---|---|
| Id | text |
| Owner | text |
| Uid | text |
| Collection | text |
| Mock Url | text |
| Name | text |
| Config | object |
| Headers | array |
| Match Body | boolean |
| Match Header | boolean |
| Match Query Params | boolean |
| Match Wildcards | boolean |
| Server Response Id | text |
| Created At | date |
2other output fields
Create a Monitor
ActionRecurring collection run with alerts.
| Field | Type |
|---|---|
WorkspaceRequired | choice |
NameRequired | text |
CollectionRequired | choice |
CronRequired | text |
Time ZoneRequired | text |
| Environment | choice |
| Active | boolean |
| Notification Limit | number |
8other input fields
| Field | Type |
|---|---|
| Id | text |
| Name | text |
| Active | boolean |
| Uid | text |
Create a Request Comment
ActionTeam feedback on a single HTTP call.
| Field | Type |
|---|---|
CollectionRequired | choice |
Request IDRequired | text |
CommentRequired | text |
| Thread ID | number |
| Tagged Users | array |
| User | object |
| Field | Type |
|---|---|
| Body | text |
| Tags | object |
| @alex-cruz | object |
Create a Response Comment
ActionFeedback on a stored example.
| Field | Type |
|---|---|
CollectionRequired | choice |
Response IDRequired | text |
CommentRequired | text |
| Thread ID | number |
| Tagged Users | array |
| User | object |
| Field | Type |
|---|---|
| Body | text |
| Tags | object |
| @alex-cruz | object |
Create a Spec
ActionAPI spec from your own files.
| Field | Type |
|---|---|
WorkspaceRequired | choice |
NameRequired | text |
TypeRequired | choice |
FilesRequired | array |
| File | object |
| Field | Type |
|---|---|
| Name | text |
| Type | text |
| Files | array |
Create a Spec File
ActionExtra document in an API spec.
| Field | Type |
|---|---|
SpecRequired | choice |
PathRequired | text |
ContentRequired | text |
| Field | Type |
|---|---|
| Created At | date |
| Created By | number |
| Id | text |
| Path | text |
| Updated At | date |
| Updated By | number |
| Type | text |
Create a Spec Version Tag
ActionLabeled checkpoint for a spec.
| Field | Type |
|---|---|
SpecRequired | choice |
NameRequired | text |
| Field | Type |
|---|---|
| Name | text |
Create a Workspace
ActionShared space for collections and specs.
| Field | Type |
|---|---|
NameRequired | text |
TypeRequired | choice |
| Description | text |
| About | text |
| Team | choice |
| Field | Type |
|---|---|
| Name | text |
| Type | text |
| Description | text |
| About | text |
Create a Workspace Update
ActionFeed post for workspace members.
| Field | Type |
|---|---|
WorkspaceRequired | choice |
TopicRequired | text |
DescriptionRequired | text |
CategoryRequired | choice |
| Related Resources | array |
| Resource | object |
| Field | Type |
|---|---|
| Description | text |
| Topic | text |
| Category | text |
| Related Resources | array |
Create an API
ActionFresh API entry for your team.
| Field | Type |
|---|---|
WorkspaceRequired | choice |
NameRequired | text |
| Summary | text |
| Description | text |
| Field | Type |
|---|---|
| Name | text |
| Summary | text |
| Description | text |
Create an API Version
ActionRelease snapshot of an API.
| Field | Type |
|---|---|
APIRequired | choice |
NameRequired | text |
| Schema IDs | array |
| Collection IDs | array |
| Release Notes | text |
| Field | Type |
|---|---|
| Collections | array |
| Name | text |
| Release Notes | text |
| Schemas | array |
Create an Environment
ActionVariable set for a workspace.
| Field | Type |
|---|---|
WorkspaceRequired | choice |
NameRequired | text |
| Variables | array |
| Variable | object |
| Field | Type |
|---|---|
| Name | text |
| Values | array |
Delete a Collection
ActionWhole collection gone for the team.
| Field | Type |
|---|---|
CollectionRequired | choice |
| Field | Type |
|---|---|
| Success | boolean |
Delete a Collection Comment
ActionClears one remark from a collection.
| Field | Type |
|---|---|
CollectionRequired | choice |
Comment IDRequired | text |
| Field | Type |
|---|---|
| Success | boolean |
Delete a Collection Folder
ActionClears a folder out of a collection.
| Field | Type |
|---|---|
CollectionRequired | choice |
Folder IDRequired | text |
| Field | Type |
|---|---|
| Success | boolean |
Delete a Collection Request
ActionClears one saved request.
| Field | Type |
|---|---|
CollectionRequired | choice |
Request IDRequired | text |
| Field | Type |
|---|---|
| Success | boolean |
Delete a Collection Response
ActionClears a stored sample reply.
| Field | Type |
|---|---|
CollectionRequired | choice |
Response IDRequired | text |
| Field | Type |
|---|---|
| Success | boolean |
Delete a Folder Comment
ActionClears a remark from a folder.
| Field | Type |
|---|---|
CollectionRequired | choice |
Folder IDRequired | text |
Comment IDRequired | text |
| Field | Type |
|---|---|
| Success | boolean |
Delete a Mock Response
ActionClears one canned mock reply.
| Field | Type |
|---|---|
Mock ServerRequired | choice |
Server Response IDRequired | text |
| Field | Type |
|---|---|
| Success | boolean |
Delete a Mock Server
ActionFake API endpoint taken down.
| Field | Type |
|---|---|
Mock ServerRequired | choice |
| Field | Type |
|---|---|
| Success | boolean |
Delete a Monitor
ActionRecurring collection run cancelled.
| Field | Type |
|---|---|
MonitorRequired | choice |
| Field | Type |
|---|---|
| Success | boolean |
Delete a Request Comment
ActionStrips a remark from a request.
| Field | Type |
|---|---|
CollectionRequired | choice |
Request IDRequired | text |
Comment IDRequired | text |
| Field | Type |
|---|---|
| Success | boolean |
Delete a Response Comment
ActionStrips a remark from a sample reply.
| Field | Type |
|---|---|
CollectionRequired | choice |
Response IDRequired | text |
Comment IDRequired | text |
| Field | Type |
|---|---|
| Success | boolean |
Delete a Spec
ActionAPI spec removed from the workspace.
| Field | Type |
|---|---|
SpecRequired | choice |
| Field | Type |
|---|---|
| Success | boolean |
Delete a Spec File
ActionClears one document from a spec.
| Field | Type |
|---|---|
SpecRequired | choice |
File PathRequired | text |
| Field | Type |
|---|---|
| Success | boolean |
Delete a Workspace
ActionEntire workspace shut down.
| Field | Type |
|---|---|
WorkspaceRequired | choice |
| Confirm | boolean |
| Field | Type |
|---|---|
| Success | boolean |
Delete a Workspace Update
ActionPulls a post from the workspace feed.
| Field | Type |
|---|---|
WorkspaceRequired | choice |
Update IDRequired | text |
| Field | Type |
|---|---|
| Success | boolean |
Delete an API
ActionRemoves one API from a workspace.
| Field | Type |
|---|---|
APIRequired | choice |
| Field | Type |
|---|---|
| Success | boolean |
Delete an API Version
ActionTrims the release history of an API.
| Field | Type |
|---|---|
APIRequired | choice |
Version IDRequired | text |
| Field | Type |
|---|---|
| Success | boolean |
Delete an Environment
ActionVariable set removed from the workspace.
| Field | Type |
|---|---|
EnvironmentRequired | choice |
| Field | Type |
|---|---|
| Success | boolean |
Duplicate a Collection
ActionCloned collection in another workspace.
| Field | Type |
|---|---|
CollectionRequired | choice |
WorkspaceRequired | choice |
| Suffix | text |
| Field | Type |
|---|---|
| Workspace | text |
| Suffix | text |
Fork a Collection
ActionLinked copy that can merge back.
| Field | Type |
|---|---|
CollectionRequired | choice |
WorkspaceRequired | choice |
LabelRequired | text |
| Field | Type |
|---|---|
| Label | text |
Fork an Environment
ActionLinked environment copy for edits.
| Field | Type |
|---|---|
EnvironmentRequired | choice |
WorkspaceRequired | choice |
Fork NameRequired | text |
| Field | Type |
|---|---|
| Fork Name | text |
Generate a Collection from a Spec
ActionTurns an API spec into requests.
| Field | Type |
|---|---|
SpecRequired | choice |
NameRequired | text |
| Request Name Source | choice |
| Indent Character | choice |
| Folder Strategy | choice |
| Include Auth Info in Example | boolean |
| Enable Optional Parameters | boolean |
| Keep Implicit Headers | boolean |
3other input fields
| Field | Type |
|---|---|
| Task Id | text |
| Url | text |
Generate a Spec from a Collection
ActionDerives a spec from saved requests.
| Field | Type |
|---|---|
CollectionRequired | choice |
NameRequired | text |
| Type | choice |
| Format | choice |
| Field | Type |
|---|---|
| Task Id | text |
| Url | text |
Make an API Call
universalYour own Postman REST API request.
| Field | Type |
|---|---|
URLRequired | text |
MethodRequired | choice |
| Headers | array |
| Row | object |
| Query String | array |
| Row | object |
| Body | text |
| Field | Type |
|---|---|
| Body | text |
| Headers | object |
| Content-type | text |
| Status Code | number |
Merge a Collection Fork
ActionBrings a fork back into its original.
| Field | Type |
|---|---|
SourceRequired | choice |
DestinationRequired | choice |
StrategyRequired | choice |
| Field | Type |
|---|---|
| Strategy | text |
| Source | text |
| Destination | text |
Merge an Environment Fork
ActionReunites an environment fork with its parent.
| Field | Type |
|---|---|
EnvironmentRequired | choice |
SourceRequired | choice |
| Delete Source | boolean |
| Field | Type |
|---|---|
| Source | text |
| Delete Source | boolean |
Publish a Mock Server
ActionMakes a mock server available to others.
| Field | Type |
|---|---|
Mock ServerRequired | choice |
| Field | Type |
|---|---|
| Mock | object |
| Id | text |
Publish the Collection Documentation
ActionPuts collection docs on the web.
| Field | Type |
|---|---|
CollectionRequired | choice |
Top Bar ColorRequired | text |
Right Sidebar ColorRequired | text |
Highlight ColorRequired | text |
Customization (JSON)Required | text |
| Environment | choice |
| Layout | choice |
| Field | Type |
|---|---|
| Custom Color | object |
| Highlight | text |
| Right Sidebar | text |
| Top Bar | text |
| Customization | object |
| Meta Tags | array |
| Appearance | object |
| Environment Uid | text |
| Documentation Layout | text |
Pull Collection Changes
ActionRefreshes a fork from upstream.
| Field | Type |
|---|---|
CollectionRequired | choice |
| Field | Type |
|---|---|
| Collection | object |
| Destination Id | text |
| Source Id | text |
Pull Environment Changes
ActionRefreshes an environment fork.
| Field | Type |
|---|---|
EnvironmentRequired | choice |
SourceRequired | choice |
| Field | Type |
|---|---|
| Source | text |
Remove an Environment Variable
ActionStrips one variable out of the set.
| Field | Type |
|---|---|
EnvironmentRequired | choice |
KeyRequired | text |
| Field | Type |
|---|---|
| Environment | object |
| Id | text |
| Name | text |
| Owner | text |
| Created At | date |
| Updated At | date |
| Values | array |
| Uid | text |
Rename a Spec
ActionNew title for an API spec.
| Field | Type |
|---|---|
SpecRequired | choice |
NameRequired | text |
| Field | Type |
|---|---|
| Id | text |
| Type | text |
| Created By | number |
| Updated By | number |
| Created At | date |
| Updated At | date |
| Name | text |
Rename an Environment
ActionNew title for an existing variable set.
| Field | Type |
|---|---|
EnvironmentRequired | choice |
NameRequired | text |
| Field | Type |
|---|---|
| Environment | object |
| Id | text |
| Name | text |
| Owner | text |
| Created At | date |
| Updated At | date |
| Values | array |
| Uid | text |
Replace a Collection
ActionSwaps in a new collection body.
| Field | Type |
|---|---|
CollectionRequired | choice |
Collection (JSON)Required | text |
| Run Async | boolean |
| Field | Type |
|---|---|
| Id | text |
| Name | text |
| Uid | text |
Replace an Environment
ActionSwaps in a new variable set.
| Field | Type |
|---|---|
EnvironmentRequired | choice |
| Name | text |
| Variables | array |
| Variable | object |
| Confirm | boolean |
| Field | Type |
|---|---|
| Name | text |
| Values | array |
Replace Workspace Variables
ActionSwaps in new global variables.
| Field | Type |
|---|---|
WorkspaceRequired | choice |
| Variables | array |
| Variable | object |
| Confirm | boolean |
| Field | Type |
|---|---|
| Values | array |
Resolve a Comment Thread
ActionCloses out a discussion thread.
| Field | Type |
|---|---|
Thread IDRequired | text |
| Field | Type |
|---|---|
| Success | boolean |
Review a Pull Request
ActionRecords a decision on a merge proposal.
| Field | Type |
|---|---|
Pull Request IDRequired | text |
ActionRequired | choice |
| Comment | text |
| Field | Type |
|---|---|
| Id | text |
| Reviewed By | object |
| Id | number |
| Name | text |
| Username | text |
| Status | text |
| Updated At | date |
Run a Monitor
ActionKicks off a monitor run now.
| Field | Type |
|---|---|
MonitorRequired | choice |
| Run in the Background | boolean |
| Field | Type |
|---|---|
| Info | object |
| Job Id | text |
| Collection Uid | text |
| Environment Uid | text |
| Monitor Id | text |
| Name | text |
| Status | text |
| Started At | date |
| Finished At | date |
Set an Environment Variable
ActionAdds or edits a single variable.
| Field | Type |
|---|---|
EnvironmentRequired | choice |
KeyRequired | text |
| Value | text |
| Type | choice |
| Enabled | choice |
| Description | text |
| Field | Type |
|---|---|
| Environment | object |
| Id | text |
| Name | text |
| Owner | text |
| Created At | date |
| Updated At | date |
| Values | array |
| Uid | text |
Set Collection Tags
ActionOverwrites the tag list on a collection.
| Field | Type |
|---|---|
CollectionRequired | choice |
| Tags | array |
| Confirm | boolean |
| Field | Type |
|---|---|
| Tags | array |
Set Workspace Tags
ActionRe-labels a workspace.
| Field | Type |
|---|---|
WorkspaceRequired | choice |
| Tags | array |
| Confirm | boolean |
| Field | Type |
|---|---|
| Tags | array |
Sync a Collection with a Spec
ActionMakes a collection follow its spec.
| Field | Type |
|---|---|
CollectionRequired | choice |
Spec IDRequired | text |
| Field | Type |
|---|---|
| Task Id | text |
| Url | text |
Sync a Spec with a Collection
ActionBrings an API definition up to date.
| Field | Type |
|---|---|
SpecRequired | choice |
CollectionRequired | choice |
| Field | Type |
|---|---|
| Task Id | text |
| Url | text |
Transfer Collection Folders
ActionRelocate or duplicate folders in a collection.
| Field | Type |
|---|---|
IDsRequired | array |
ModeRequired | choice |
Target IDRequired | text |
Target KindRequired | choice |
PositionRequired | choice |
| Location ID | text |
| Field | Type |
|---|---|
| Ids | array |
Transfer Collection Requests
ActionShift or clone requests between targets.
| Field | Type |
|---|---|
IDsRequired | array |
ModeRequired | choice |
Target IDRequired | text |
Target KindRequired | choice |
PositionRequired | choice |
| Location ID | text |
| Field | Type |
|---|---|
| Ids | array |
Transfer Workspace Elements
ActionRelocates items across workspaces.
| Field | Type |
|---|---|
WorkspaceRequired | choice |
Element IDsRequired | array |
TypeRequired | choice |
Target WorkspaceRequired | choice |
| Field | Type |
|---|---|
| Id | text |
| Type | text |
| To | text |
Unpublish a Mock Server
ActionWithdraws a published mock server.
| Field | Type |
|---|---|
Mock ServerRequired | choice |
| Field | Type |
|---|---|
| Mock | object |
| Id | text |
Unpublish the Collection Documentation
ActionStops sharing collection docs.
| Field | Type |
|---|---|
CollectionRequired | choice |
| Field | Type |
|---|---|
| Success | boolean |
Update a Collection
ActionAlters collection settings and scripts.
| Field | Type |
|---|---|
CollectionRequired | choice |
| Name | text |
| Description | text |
| Variables | array |
| Variable | object |
| Auth (JSON) | text |
| Events (JSON) | text |
| Field | Type |
|---|---|
| Id | text |
| Name | text |
| Description | text |
Update a Collection Comment
ActionReworded remark on a collection.
| Field | Type |
|---|---|
CollectionRequired | choice |
Comment IDRequired | text |
CommentRequired | text |
| Tagged Users | array |
| User | object |
| Field | Type |
|---|---|
| Body | text |
| Tags | object |
| @alex-cruz | object |
Update a Collection Folder
ActionRetitles or redescribes a folder.
| Field | Type |
|---|---|
CollectionRequired | choice |
Folder IDRequired | text |
| Name | text |
| Description | text |
| Field | Type |
|---|---|
| Data | object |
| Id | text |
| Name | text |
| Description | text |
| Created At | date |
| Updated At | date |
| Owner | text |
| Last Updated By | text |
| Last Revision | number |
| Collection | text |
| Folder | text |
| Meta | object |
| Action | text |
| Model | text |
| Model id | text |
| Revision | number |
Update a Collection Request
ActionRewrites a saved request.
| Field | Type |
|---|---|
CollectionRequired | choice |
Request IDRequired | text |
| Name | text |
| Method | choice |
| URL | text |
| Description | text |
| Headers | array |
| Row | object |
| Query Parameters | array |
| Row | object |
8other input fields
| Field | Type |
|---|---|
| Data | object |
| Id | text |
| Name | text |
| Description | text |
| Created At | date |
| Updated At | date |
| Owner | text |
| Last Updated By | text |
| Last Revision | number |
| Auth | text |
| Collection | text |
| Meta | object |
| Action | text |
| Model | text |
| Model id | text |
| Revision | number |
Update a Collection Response
ActionTweaks a saved sample reply.
| Field | Type |
|---|---|
CollectionRequired | choice |
Response IDRequired | text |
| Name | text |
| URL | text |
| Method | choice |
| Status Code | number |
| Status Text | text |
| Headers | array |
| Row | object |
4other input fields
| Field | Type |
|---|---|
| Name | text |
| Headers | object |
| 0 | object |
| 1 | object |
| 2 | object |
| 3 | object |
| Response Code | object |
| Code | number |
| Name | text |
| Status | text |
| Time | text |
| Cookies | text |
| Mime | text |
| Text | text |
9other output fields
Update a Folder Comment
ActionRewords a folder remark.
| Field | Type |
|---|---|
CollectionRequired | choice |
Folder IDRequired | text |
Comment IDRequired | text |
CommentRequired | text |
| Tagged Users | array |
| User | object |
| Field | Type |
|---|---|
| Body | text |
| Tags | object |
| @alex-cruz | object |
Update a Mock Response
ActionReshapes a canned mock reply.
| Field | Type |
|---|---|
Mock ServerRequired | choice |
Server Response IDRequired | text |
| Name | text |
| Status Code | number |
| Headers | array |
| Row | object |
| Language | choice |
| Body | text |
| Field | Type |
|---|---|
| Server Response | object |
| Name | text |
| Status Code | number |
| Headers | array |
| Language | text |
| Body | text |
Update a Mock Server
ActionChanges the settings of a fake API server.
| Field | Type |
|---|---|
Mock ServerRequired | choice |
| Name | text |
| Environment | choice |
| Collection | choice |
| Description | text |
| Private | choice |
| Version Tag | text |
| Server Response ID | text |
1other input field
| Field | Type |
|---|---|
| Id | text |
| Owner | text |
| Uid | text |
| Collection | text |
| Mock Url | text |
| Name | text |
| Config | object |
| Headers | array |
| Match Body | boolean |
| Match Header | boolean |
| Match Query Params | boolean |
| Match Wildcards | boolean |
| Server Response Id | text |
| Created At | date |
2other output fields
Update a Monitor
ActionAdjusts a scheduled run.
| Field | Type |
|---|---|
MonitorRequired | choice |
| Name | text |
| Cron | text |
| Time Zone | text |
| Active | choice |
| Notification Limit | number |
| Retry Attempts | number |
| Email on Error | array |
7other input fields
| Field | Type |
|---|---|
| Active | boolean |
Update a Request Comment
ActionRewrites feedback on a request.
| Field | Type |
|---|---|
CollectionRequired | choice |
Request IDRequired | text |
Comment IDRequired | text |
CommentRequired | text |
| Tagged Users | array |
| User | object |
| Field | Type |
|---|---|
| Body | text |
| Tags | object |
| @alex-cruz | object |
Update a Response Comment
ActionEdits a sample reply remark.
| Field | Type |
|---|---|
CollectionRequired | choice |
Response IDRequired | text |
Comment IDRequired | text |
CommentRequired | text |
| Tagged Users | array |
| User | object |
| Field | Type |
|---|---|
| Body | text |
| Tags | object |
| @alex-cruz | object |
Update a Spec File
ActionRewrites a spec document.
| Field | Type |
|---|---|
SpecRequired | choice |
File PathRequired | text |
| Name | text |
| Type | choice |
| Content | text |
| Field | Type |
|---|---|
| Created At | date |
| Created By | number |
| Id | text |
| Path | text |
| Updated At | date |
| Updated By | number |
| Type | text |
Update a Workspace
ActionAdjusts the settings of a workspace.
| Field | Type |
|---|---|
WorkspaceRequired | choice |
| Name | text |
| Type | choice |
| Description | text |
| About | text |
| Clear Fields | choice |
| Field | Type |
|---|---|
| Name | text |
| Type | text |
| Description | text |
| About | text |
Update a Workspace Update
ActionEdits a feed post.
| Field | Type |
|---|---|
WorkspaceRequired | choice |
Update IDRequired | text |
TopicRequired | text |
DescriptionRequired | text |
CategoryRequired | choice |
| Related Resources | array |
| Resource | object |
| Pinned | choice |
| Field | Type |
|---|---|
| Description | text |
| Topic | text |
| Category | text |
| Is Pinned | boolean |
| Related Resources | array |
Update an API
ActionAdjusts the metadata of an API.
| Field | Type |
|---|---|
APIRequired | choice |
| Name | text |
| Summary | text |
| Description | text |
| Field | Type |
|---|---|
| Name | text |
| Summary | text |
| Description | text |
Templates
Look for Postman templates in the WEXTL template library.
Browse templates →Other developer tool integrations on WEXTL
API Verve[2]One key for hundreds of utility APIs: validate emails and phones, look up domains, IPs and companies, convert files and text, and more.
BuildkiteContinuous integration and delivery platform for running fast, secure pipelines.
0CodeKitPDF, image, AI, data validation and conversion tools for automations.
CockpitManage collections and content entries in a self-hosted Cockpit CMS instance.
AWS CognitoAmazon Cognito User Pools. Manage users, groups, app clients and identity providers with SigV4.
References
- WEXTL® Postman Source Code connector implementation.
- Our users use cases and automations.
- Official API Documentation for Postman.
- 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.






























