@builtioflow/connector-builder

Built.io Flow connector builder

Install

npm i @builtioflow/connector-builder -g

Contents

• Get Started
• Commands
• Guide To Creating A New Connector

Get Started

Built.io Flow connector builder is a Command Line Interface tool for Built.io Flow. It lets you build your own connectors for Built.io flow. Using Built.io Flow connector builder you can deploy your connector to Built.io and share it with others.

Commands

Following are the commands which Built.io Flow connector builder supports.

• flow connectors
• flow auth
• flow create
• flow deploy
• flow download
• flow help
• flow history
• flow init
• flow login
• flow logout
• flow share
• flow unshare
• flow versions
• flow import
• flow oauth
• flow attach
• flow detach
• flow collaborate
• flow postman

connectors

Use this command to display all the connectors created by current user.

  flow connectors

Sample Output:

| App Name  |      Version    |      created_at          |
|---------- |-----------------| -------------------------|
| Github    |   1.0           | 2017-06-19T14:22:23.485Z |
| Facebook  |   2.0           | 2017-06-20T11:11:24.485Z |
| Gmail     |   2.0           | 2017-06-23T10:03:22.485Z |

auth

Use this command to add an authentication for your connector.

  flow auth

create

Use this command to add a new trigger, action, lookup.

  flow create trigger new_push
  flow create action create_user
  flow create lookup list_users

deploy

Use this command for building and deploying the connector on Built.io Flow.

  flow deploy

download

Use this command for download a zip file of your connector.

  flow download

help

Use this command to list all the commands you can use.

  flow help

Sample Output:

|  Command    |    Example                           |                      Info                                  |
|----------   |--------------------------------------|------------------------------------------------------------|
| connectors  |   flow connectors                    | Lists all the connectors of the current user               |
| auth        |   flow auth                          | Adds an authentication for your connector                  |
| create      |   flow create trigger trigger_name   | Adds a new trigger, action and lookup                      |
| deploy      |   flow deploy                        | Builds and deploys connector on Built.io Flow              |
| download    |   flow download                      | Downloads zip of your connector                            |
| help        |   flow help                          | Lists all the commands                                     |
| history     |   flow history                       | Shows the activity history of your current connector       |
| init        |   flow init example                  | Initializes a new connector                                |
| login       |   flow login                         | Login to Built.io Flow account                             |
| logout      |   flow logout                        | Logout from Built.io Flow account                          |
| share       |   flow share                         | Shares your connector with other Built.io Flow users       |
| unshare     |   flow unshare                       | Unshares your connector from a specific user               |
| versions    |   flow versions                      | Lists all the versions of your current connector           |
| oauth       |   flow oauth deploy                  | Deploy custom user oauth to Built.io Flow                  |
| attach      |   flow attach lookup                 | To attach lookup in any specific actions or triggers field |
| detach      |   flow detach lookup                 | To detach lookup in any specific actions or triggers field |
| collaborate |   flow collaborate                   | To collaborate connector with other user                   |
| postman     |   flow postman [file.json]           | To import action from postman collection exported json     |

history

Use this command to view the complete history of your current connector.

  flow history

Sample Output:

|     User       |      Operation          | Message                |  Date & Time                |
|----------------|-------------------------|------------------------|-----------------------------|
| [e-mail]  | Created trigger         | Name: Received email   | 2017-06-23T08:51:56.815Z    |
| [e-mail]  | Created action          | Name: Save draft       | 2017-06-23T09:10:22.248Z    |
| [e-mail]  | Deployed application    | Version: 1             | 2017-06-23T09:10:30.702Z    |

init

Use this command to create an initial project.

  flow init [path] [foldername] --template=minimal
  flow init example

• Options
  • template - Optional template argument. Default minimal

login

Use this command for configuring your deploy key and logging into Built.io Flow

  flow login

logout

Use this command for deleting access token from your home directory.

  flow logout

share

Use this command for sharing your connector with other users.

  flow share

unshare

Use this command for unsharing your connector from a specific user.

  flow unshare

versions

Use this command for displaying all the versions and their status of the current connector.

  flow versions

Sample Output:

| App name  |   Version     |  Status   |
|---------- |:------------: |-----------|
| Github    |      1        | Published |
|           |      2        | Pending   |
-----------------------------------------

import

To import all swagger api calls as an action in connector.

  flow import <swagger file path>

oauth

To deploy custom user oauth to Built.io Flow

  flow oauth deploy

attach lookup

To attach lookup in any specific action's or trigger's input field.

  flow attach lookup

detach lookup

To detach lookup in any specific action's or trigger's input field.

  flow detach lookup

collaborate

To collaborate connector with other user

  flow collaborate

postman

To create actions from postman collections exported json

  flow postman [box-exported-v2.1.json]