Skip to content

Export & Import Connections

You can export all your connections to a YAML file and import them into another team or environment. This is useful for migrating setups, sharing connection templates, or backing up your configuration.

Exporting Connections

  1. Go to the Connections page
  2. Click "Export" in the header
  3. A connections.yaml file will be downloaded containing all your connections

WARNING

The exported file contains real credentials (API keys, passwords, tokens) in plain text. Treat it as a sensitive file and store it securely.

Importing Connections

  1. Go to the Connections page
  2. Click "Import" in the header
  3. Select a .yaml or .yml file
  4. Each connection in the file will be created as a new connection

Imported connections are always created as new entries — they will not overwrite or update existing connections with the same name.

TIP

After importing, test each connection to make sure the credentials are valid in the new environment.

YAML File Format

The YAML file uses a simple structure with a top-level connections list. Each entry requires name, type, and credentials:

yaml
connections:
  - name: Production MySQL
    type: mysql
    credentials:
      host: db.example.com
      port: 3306
      database: app_production
      username: app_user
      password: secret123

  - name: Slack Bot
    type: slack
    credentials:
      bot_token: xoxb-your-bot-token

  - name: GitHub API
    type: github
    credentials:
      token: ghp_your-personal-access-token

Required Fields

FieldDescription
nameA descriptive name for the connection
typeThe connection type identifier (e.g. mysql, slack, github)
credentialsKey-value pairs specific to the connection type

Connection Types and Credentials

Each connection type expects different credential fields. Refer to the individual connection type pages for the specific fields required:

  • Databases: host, port, database, username, password
  • API services (Slack, GitHub, Stripe, etc.): typically api_key, token, or bot_token
  • Google services: client_id, client_secret, refresh_token
  • SMTP: host, port, username, password, from_email

See each connection type's documentation page for the full list of credential fields.

Example: Multiple Connection Types

yaml
connections:
  - name: Analytics DB
    type: postgres
    credentials:
      host: analytics.internal
      port: 5432
      database: analytics
      username: reader
      password: readonly_pass

  - name: Company Slack
    type: slack
    credentials:
      bot_token: xoxb-1234567890-abcdefghij

  - name: S3 Backups
    type: aws_s3
    credentials:
      access_key_id: AKIAIOSFODNN7EXAMPLE
      secret_access_key: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
      region: us-east-1

  - name: Outbound Email
    type: smtp
    credentials:
      host: smtp.gmail.com
      port: 587
      encryption: tls
      username: alerts@company.com
      password: app-password
      from_email: alerts@company.com
      from_name: Workflow Alerts

Error Handling

If some connections fail to import (e.g. invalid type or missing fields), the valid ones will still be created. You will see error messages for each connection that could not be imported.