⚙️Campaign Settings
How do I whitelist my IP address and obtain my API keys?
Last updated
How do I whitelist my IP address and obtain my API keys?
Last updated
You will be able to obtain your campaign API keys and whitelist your IP address from your campaign's settings pop-up, under the integrations tab. This part will be accessible after you have created and saved your campaign.
Click on your campaign and the settings icon, this will open up your settings pop-up.
Please ignore TODO: Persist sender ID under the Sender ID field.
You will be able to view the following details
Campaign ID
Campaign Channel
Campaign Message
Download campaign logs
Learn about the two types of access rights in Postman.
| Campaign Owner | Member |
|---|---|
can send messages within the campaigns | can send messages within the campaigns |
can access and amend campaign settings: - add other users to their campaigns and grant different access rights, see image below - whitelist IP addresses - generate API keys | no access to campaign settings |
For agency officers without a .gov.sg email domain, you will need to get .gov.sg email domain from your parent ministry.
Non gov.sg domains that are considered government entities
For now, this is limited to aic.sg, synapxe.sg, edu.sg
*By default, every user with this domains has member access rights.
Users with these domains who need admin access (i.e. can create campaigns, access and amend campaign settings) must request for specific email address whitelisting through the agency PIC using this form
Otherwise, all users with these domains can already log into Postman and view campaigns they have been added to (i.e. member access)
Vendors helping government entities with API integrations
In such cases, Postman will not be granting vendors access to the portal. This means vendors with non-whitelisted email domains cannot log into Postman.
Agency officers should log into Postman, create the campaign and craft the message, whitelist the IP addresses, generate the API keys and pass the API keys to the vendors for the necessary integration.
Vendors helping government entities send messages on Postman UI
In such cases, agency PICs must submit a request for the Postman team to whitelist the vendor's domain. This will allow vendors to log into Postman, and view campaigns that the vendors have been added to by the agency admins.
Vendors will then be able to log in and send messages, but not create campaigns i.e. member access
Integrations are where you can whitelist your IP addresses and generate your API keys.
Provide your IP address for whitelisting. You will be able to provide up to 20 IP addresses.
Whitelist only
Static IP addresses
IP addresses that you are using to call the Postman API.
Connect to a VPN before calling the Postman APIs.
You will only be able to obtain your API keys after you have whitelisted your IP address.
One campaign can have up to 3 API keys.
The API keys have no expiry.
If you need to obtain a new API key, you can simply delete the old key and generate a new key.
