Skip to main content

Connections

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

  • a Javascript Block
  • a Block that relies on that Connection as a part of its configuration.

Connections are managed the Ziggy UI.

Connections

The following connection types are currently supported.

  • Hubspot
  • SalesForce
  • 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 - use mostly from the SQL 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.

Connection object

Development and Production​

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

Secrets​

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

The typical connection objects are shown below. Full details can be found in Elastic docs. The Ziggy connection object is what you are looking for. Note that the object is different for Severless, Hosted and Local offerings.

Serverless

{
  node: 'https://my-elasticsearch-project-xxxx.es.eu-west-1.aws.elastic.cloud:443',
  auth: {
    apiKey: secrets.ELASTIC_API_KEY
  }
  serverMode: 'serverless',
}

Hosted

{
    cloud: {
        id: 'My_deployment:your_deployment_id='
    },
    auth: {
        username: 'elastic',
        password: secrets.MY_ELASTIC_PW
    }
}

Hubspot object​

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

SalesForce object​

{
    username: "myemail4@agentforce.com",
    password: "H8KK87KHJA7JGH7",
    token: '987JHGehKJHh7KJh8wOiu77dd'
}

SFTP object​

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

AWS S3 object​

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

Upsales​

{
url: 'https://power.upsales.com/api/v2/',
apiKey: secrets.UPSALES_API_KEY
}

Database object​

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
}