Build a new connector with Postman

2. Create a new collection

A number of premade templates are available to help you create your own custom Postman connectors.

Use this tool to generate a new Postman collection, then follow the steps below to import it into Postman.

Create a new collection

Follow the simple steps in this tool to create your own Postman collection template, which you can edit to suit your API.

  1. This field is required.
  2. RSS Feed

Importing collections into Postman

The following steps require the native version of the Postman application. The deprecated Chrome app is not supported.

To import your collection template into Postman, select Import from the top navigation bar.

Import a collection

In the dialog that opens, select Choose Files and open the file you just downloaded.

Postman Import modal

The collection is now ready for use, and can be accessed from the left sidebar in Postman.

Imported collection is now available

Adding Collection and Card metadata

Collection and Card metadata is displayed when adding and editing Postman connectors in Digital Assistant. You can edit this metadata in Postman to make it easy to know what a connector does and what Cards it contains, as well as add Utterances and Card features to Cards.

To edit a Collection's metadata, hover on the Collection and click the ellipsis icon to open the More actions menu. Next, select Edit.

Collection metadata should be entered in the Description tab and should follow the following format. Markdown is supported.

# Title
Description of the connector
![logo](https://www.yourwebsite.com/path-to-logo.svg)
Title
The title of the Collection
Description
A brief description of the Collection
Logo
The icon displayed in the corner of Cards from the collection. This must be a publicly accessible URL and the image must be an SVG.

This will appear in Digital Assistant as follows:

Connection metadata modal in Digital Assistant

Card metadata can be editied by following a similar process. Click on the Collection to expand it, then hover over the Card you want to edit. Click the ellipsis icon to open the More actions menu, then select Edit.

Card metadata should be entered in the Description tab and should follow the following format. Markdown is supported.

# Title
Description of the Card

## Audience
All

## Features
Notifications

## Utterances
1. Show me this Card
Title
The title of the Card
Description
A brief description of the Card
Audience
Which users should be able to view the Card. Defaults to All (Card is added to the board of all users)
Features
What features the Card supports. Defaults to Notifications (Card updates will be displayed in the Notifications area)
Utterances
An ordered list of utterances that will trigger displaying the Card.

This will appear in Digital Assistant as follows:

Card metadata modal in Digital Assistant