Creating Connections
Learn how to create connections for S3, Database, REST API, Stripe, and Airwallex
Creating Connections
Connections are created through the Connections interface. Each connection type requires specific configuration details. All connections require a name and description.
Common Fields
All connection types require:
- Connection Name: Unique identifier for the connection
- Description: Optional description of the connection's purpose
Connection Types
S3 Connection
Connect to AWS S3 buckets for file storage and data access.
Required Fields:
- AWS Bucket: Name of the S3 bucket
- AWS Region: AWS region where the bucket is located
Authentication Options:
- No Authentication: For public buckets
- AWS Credentials: Access Key ID and Secret Access Key
- IAM Role: Assume an IAM role with Role ARN, Session Name, and External ID
Optional Fields:
- AWS URL: Custom S3 endpoint URL
Database Connection
Connect to external databases (PostgreSQL, MySQL, Oracle) for data access.
Required Fields:
- Database Type: PostgreSQL, MySQL, or Oracle
- Database User: Username for database access
- Database Password: Password for database access
Configuration Options:
Simple Configuration:
- Database Host: Database server hostname or IP
- Database Port: Database server port
- Default Database: Default database name
Advanced Configuration:
- Connection URL: Full JDBC connection URL
- Driver Class Name: JDBC driver class name
- Database Properties: Additional connection properties
REST API Connection
Connect to external REST APIs with various authentication methods.
Required Fields:
- API URL: Base URL of the REST API endpoint
- HTTP Method: GET, POST, PUT, or DELETE
Optional Fields:
- Query Parameters: URL query parameters
- Headers: HTTP headers
- Request Body: Request body content
Authentication Types:
- None: No authentication required
- Basic: Username and password
- API Key: API key with optional header name
- OAuth2: Client ID, Client Secret, Token URL, Scope
- OAuth1: Consumer Key, Consumer Secret, Token ID, Token Secret, Signature Method
Stripe Connection
Connect to Stripe payment processing service.
Required Fields:
- API Key: Stripe secret API key
Optional Fields:
- Publishable Key: Stripe publishable key
- Success URL: Redirect URL for successful payments
- Failure URL: Redirect URL for failed payments
- Currency: Default currency code
- Webhook API Key: API key for webhook verification
Airwallex Connection
Connect to Airwallex payment processing service.
Required Fields:
- Base URL: Airwallex API base URL
- OAuth2 Credentials: Client ID and Client Secret
Optional Fields:
- Publishable Key: Airwallex publishable key
- Success URL: Redirect URL for successful payments
- Failure URL: Redirect URL for failed payments
- Currency: Default currency code
- Webhook API Key: API key for webhook verification
Creating a Connection
- Navigate to Connections
- Click "Create Connection"
- Enter connection name and description
- Select connection type
- Fill in required fields for the selected type
- Configure authentication if required
- Test the connection
- Save the connection
Testing Connections
After creating a connection, test it to verify:
- Credentials are correct
- Network connectivity is available
- Permissions are properly configured
Schema Import
After creating and testing a connection, you can import schema to understand available data structures:
- S3: Import file structure and field mappings
- Database: Import table schemas and column definitions
- REST API: Import API response schemas
Related Introduction
- Connections Introduction - Overview of connections
- S3DataLoad - Use S3 connections in workflows
- DbDataLoad - Use database connections in workflows