Northbeam | Polytomic Docs

Supports:

✅ Models
✅ Model sync destination
✅ Bulk sync source
✅ Connection Proxy

Connection

Configuration

Name	Type	Description	Required
`api_key`	`string`	API Key	`true`
`data_client_id`	`string`	Data Client ID	`true`
`instance`	`string`	Instance Accepted values: `prod`, `test`	`true`

Example

1 {
2   "name": "Northbeam connection",
3   "type": "northbeam",
4   "configuration": {
5     "api_key": "",
6     "data_client_id": "",
7     "instance": ""
8   }
9 }

Model Sync

Source

Configuration

Name	Type	Description	Required
`object`	`string`	Object	`true`

Example

1 {
2   ...
3   "configuration": {
4     "object": "object"
5   }
6 }

Target

Northbeam connections may be used as the destination in a model sync.

Bulk Sync

Source

Northbeam connections may be used as a bulk sync source. No additional configuration options are required.

1	{
2	"name": "Northbeam connection",
3	"type": "northbeam",
4	"configuration": {
5	"api_key": "",
6	"data_client_id": "",
7	"instance": ""
8	}
9	}