Create a Connector

Authorization

API Key

x-api-key<token>

Authenticate using API Key in request header

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

type*string

The connector type.

Value in"box" | "paragon"

name*string

Human-friendly name for this connector.

workflowID?string

One of workflowID or workflowName must be provided.

If both are provided, they must refer to the same workflow.

workflowName?string

One of workflowID or workflowName must be provided.

If both are provided, they must refer to the same workflow.

boxClientID?string

Box client ID (from your Box application).

boxClientSecret?string

Box client secret (from your Box application).

boxEnterpriseID?string

Box enterprise ID.

boxFolderID?string

Box folder ID to watch for new uploads.

paragonIntegration?string

Paragon integration, eg. "googledrive".

paragonConfiguration?object

Configuration specific to the type of integration.

Response Body

`application/json`

curl -X POST "https://api.bem.ai/v2/connectors" \  -H "Content-Type: application/json" \  -d '{    "name": "Box → Invoice workflow",    "workflowID": "wf_2N6gH8ZKCmvb6BnFcGqhKJ98VzP",    "type": "paragon",    "paragonIntegration": "googledrive",    "paragonConfiguration": {      "folderId": "YOUR_GOOGLE_DRIVE_FOLDER_ID"    }  }'

{
  "type": "box",
  "connectorID": "string",
  "name": "string",
  "workflowID": "string",
  "workflowName": "string",
  "boxClientID": "string",
  "boxClientSecret": "string",
  "boxEnterpriseID": "string",
  "boxFolderID": "string",
  "paragonSyncID": "string",
  "paragonIntegration": "string",
  "paragonConfiguration": {}
}

Create a Connector

Authorization

Request Body

Response Body

200application/json

`application/json`