Testing with Postman
Installing the Collection
To install the Postman Collection you will need to have installed the Postman App for Windows, Mac or Chrome. You can download any of these from the Postman Apps page.
Once you have Postman installed, go to
Import menu and select
Import from link. Then, paste the following url:
After clicking on
Import, Postman will open the collection.
Configuring the Postman Environment
The Webtask Postman collection make use of environment variables to customize the requests being sent. More information on managing Postman environments can be found at Setting up an environment with variables
You will need to create an environment and configure the following variables:
webtask_container: Should contain your webtask container, e.g. my-container.
webtask_token: Should contain the token needed when making calls to the Webtask API.
webtask_name: Should contain the name of the webtask that you want to work with.
webtask_url: Represents the main URL used to execute extensions. This variable defaults to
sandbox.auth0-extend.comand will not need to be modified for most users.
In the screenshot below you can see a Postman environment configured with the
webtask_name variables defined:
Executing a request
Once the environment is configured, you can follow theses steps to execute an Webtask API method:
- Select the environment you want to work with
- Select the relevant API method in the collection folder
- Click the send button
You man also optionally have to configure query parameters or the JSON method body, depending on the API call. For more information please refer to the Sending Requests document on the Postman website.
Storing tokens in Postman variables
We do need to point out that storing tokens in Postman as environment variables could pose a potential security risk. If you are signed in to the Postman application it will automatically try and synchronize some entities such as Collections and Environments with the Postman servers. This means that a token, which could allow someone else to gain access to your Management API, is leaving the privacy of your computer and uploaded Postman’s servers.
It also has to be said that Postman has taken measures to ensure that this information is encrypted, and indeed encourages users to store this sort of information in Environment Variables. You can read more about this on their website.
If you feel that this still poses too much of a risk for you, then you will need to sign out of Postman to ensure that environment variables are not synchronized.