# About Postman

Postman is a mass messaging tool for the Singapore Government. These messages can be sent via our web app directly (see [campaign guide](https://guide.postman.gov.sg/campaign-guide/before-you-start)) or via API integration (see [API guide](https://guide.postman.gov.sg/api-guide/overview)).

We've sent out more than 100 million messages from over 90 agencies. These include quarantine orders, COVID-19 test results, and employer notices.

Start using Postman by logging in with your `@agency.gov.sg` email address!

## What can Postman Web App do?

* **Easily customize messages to reach a wide audience**: Create a message template, upload a file containing customization parameters, and we will handle the rest for you.
* **Mass send emails**: Just click `Send campaign` and Postman will send those messages out to your intended audience via email.
* **Mass send SMSes**: Enter your Twilio credentials under `Settings`, and Postman will send those messages via SMS. No integration with Twilio is needed.
* **View stats**: Keep track of your campaign's progress as it is sending and check back when it is completed.
* **Scheduled sending**: Create your campaign but send it out at a later **time**.

## What can Postman API do?

We provide a **modern, cost-effective, and compliant PaaS** for government agencies to send programmatic emails and messages. Head over to the [API guide](https://guide.postman.gov.sg/api-guide/overview) to find out more.

## Is Postman secure?

Emails, SMSes and Telegram messages are not 100% secure. Users should be wary of putting sensitive information directly in your message body. Depending on the level of sensitivity, users can consider using recipient-specific, high-entropy links or requiring further authentication to see sensitive information.

## Can Postman be accessed on the government intranet?

The Postman web app can be accessed on GSIBs that allows Secure Internet Surfing.

## What data can Postman handle?

We use cloud infrastructure so we can handle up to **Confidential (Cloud-Eligible)** data. For more information, you may refer to the section of our guide on [IM8 Policies](https://postman-v1.guides.gov.sg/~/changes/YeLkNyuQOW0qmXU37t7T/email-api-guide/overview/im8-policies) (`.gov.sg` login required).

| Normal email/SMS         | Non-sensitive to sensitivity low-normal | <ul><li>Transaction</li><li>Notification</li><li>Information broadcast</li><li>Receipts</li><li>Reminders</li></ul> |
| ------------------------ | --------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
| Password-protected email | Sensitivity high/restricted             | <ul><li>COVID-19 test result</li><li>Blood test result</li><li>Exam test result</li></ul>                           |

## Difference between the Web App and Programmatic APIs

**Web App:** Users can access Postman by going to <https://postman.gov.sg>. The web app has a user interface that allows users to send templated messages via campaigns.

**Programmatic APIs**: Users who manage their own systems could also call our APIs to send messages programmatically. In order to use this feature, you need to generate an API key from `Settings` in the Postman web app. You can find more by going to our API Guide [here](https://guide.postman.gov.sg/api-guide/overview).

| Access Type                                                                    | Channels                     | Type of Use Case             | Prerequisite                                                                                                                                                                                      |
| ------------------------------------------------------------------------------ | ---------------------------- | ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [Web app](https://guide.postman.gov.sg/campaign-guide/quick-start)             | Email, SMS, and Telegram Bot | Manual intervention required | <p><code>@agency.gov.sg</code> email access to log in</p><p><br>You will need to request for a <code>@agency.gov.sg</code> email address from your respective agency if you do not have one. </p> |
| [API](https://github.com/opengovsg/postmangovsg/blob/master/docs/api-usage.md) | Email & SMS                  | System-generated             | Engineering or IT team to send messaging info from the source system to Postman.                                                                                                                  |

## Open-source contribution

Postman is open-sourced. Visit our [GitHub repo](https://github.com/opengovsg/postmangovsg) to start contributing to our code. Contributing guidelines can be found [here](https://github.com/opengovsg/postmangovsg/blob/master/docs/CONTRIBUTING.md).

![](https://4126954886-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MAQH3DF49Lq0AJudrbF%2Fuploads%2Fgit-blob-ea3d372d47c61bfa4492127ddb936c80b53ee8cc%2Fgithub-icon-png-26.jpg?alt=media)
