Skip to main content

Create a Postman API key

A Postman API key lets StackOne work with your Postman team’s workspaces, collections and other data. The key has the same access as the Postman user who creates it, so create it with an account that can see everything you want to connect.

1

Generate the key

Sign in to your Postman account on the team you want to connect, then click Settings in the header.

  • Click Account settings.
  • If Postman asks you to sign in again, sign in with the same account.
  • Click API keys.
  • Click Generate API key.
  • Name your key: StackOne-Integration
  • Click Generate API Key.
The Generate an API key dialog with the key name filled in and the Generate API Key button highlighted
2

Copy the key

Click Copy to Clipboard, then copy the API Key into StackOne Hub.

  • Postman shows the key only once and it cannot be retrieved later, so copy it before you close the dialog.
The Copy your API key dialog with the key hidden and the Copy to Clipboard button highlighted
3

Set the key expiry

On the API keys page, API key settings controls when unused keys expire.

  • Select Never expire API keys, or API keys expire after and choose the number of days of inactivity.
  • Click Save API Key Settings.
  • When the key expires, the connection stops working until you add a new key in StackOne Hub.
The API keys page showing API key settings and the Generate API key button

Find your region

The Region is the Postman data center that hosts your team. Leave it empty or select US for the standard region.

  • Select EU only if your team uses Postman Enterprise EU Data Residency, where the Postman API runs at api.eu.postman.com.
  • EU accounts are added in the Postman desktop app: in the Help menu, select Region Preference for New Accounts > Use EU Region by Default, then sign in and create the key in that account.

Revoke the key

To stop StackOne from using your Postman account, delete the key on the API keys page.

1

Delete the key

Click Settings in the header, then Account settings > API keys.

  • Click the more actions icon next to the key.
  • Click Delete.
  • Click Delete API Key to confirm.
  • To rotate the key instead, click Regenerate and copy the new key into StackOne Hub.
The API keys list with a key's actions menu open and Delete highlighted
1

Connect

  • Click Connect.
  • If applicable, the provider will redirect you to a sign-in or authorization page. Complete the provider’s authorization flow.
  • Once authorization is successful, you will see a confirmation popup.
2

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.

Next Steps

Webhooks setup

Configure receiving Events for Postman into StackOne.