Connections

Connections are hooks into external modules along with a corresponding setup that you can reference from

Connections are managed the Ziggy UI.

The following connection types are currently supported.

Hubspot
SFTP - there is a core block that handles common use cases, but you can also access the SFTP client from the Javascript block.
AWS S3
Database - there is a Database Block, but you can also access a Database Connection client from the Javascript block.

It is very easy to add any other connection types. Anything that is available as an NPM module can be quickly added.

Configuration

The configuration you enter is an object. The example below shows a Hubspot connection object.

Note that you can specify a different connection object for Development and Production modes. Click here for details on switching modes.

It is good practice to use the Secrets Manager to avoid exposing sensitive information in the Connection object.

{
    accessToken: secrets.HUBSPOT_API_KEY,
    numberOfApiCallRetries: 5,
}

{
    host: 'my-sftp-server.com',
    port: '22',
    username: 'a8759b3dxxxxxx70c146ed99fc2xxxx',
    password: 'XMsxxxxry8yN5flxxxxBEktDGV2Rw'
}

{
    region: 'us-east-1',
    credentials: {
    accessKeyId: secrets.S3ExperimentorKeyId,
    secretAccessKey: secrets.S3ExperimentorSecret,
  },
}

Currently Postgres is the only supported database connection, but SQL Server, MySQL and MongoDB are coming shortly.

{
    host: 'connectionUrl',
    user: 'username',
    password: 'password',
    database: 'my_database',
    port: 5432
}

24 April 2025